Draft PH Core Implementation Guide
0.2.0 - ci-build Philippines flag

Draft PH Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PH Core Patient

Official URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/ph-core-patient Version: 0.2.0
Draft as of 2026-04-10 Computable Name: PHCorePatient

Captures key demographic and administrative information about individuals receiving care or other health-related services.

The PH Core Patient profile captures key demographic and administrative information about individuals receiving care or other health-related services in the Philippines.

Name Representation

Per naming conventions, the middle name (usually the mother's maiden surname in most cases) is represented using the given[1] array:

  • given[0]: First name (e.g., "Paolo Niccolo")
  • given[1]: Middle name (e.g., "Buenaventura")
  • family: Family name (e.g., "Macalalad")

Example

A person named "Paolo Niccolo Buenaventura Macalalad" would be represented as:

{
  "use": "official",
  "given": ["Paolo Niccolo", "Buenaventura"],
  "family": "Macalalad"
}

Birth Date and Age Derivation

Deriving birthDate from Age Information

Implementers should derive birthDate from age information rather than capturing age in extensions or other elements. This ensures consistency and interoperability across implementations.

Rules for Setting birthDate with Partial Age Information

When only partial age information is known, set birthDate according to the following rules:

Known Information birthDate Format Example (Current Date: 2026-03-19)
Only year known YYYY Age = 2 years old → 2024
Month and year known YYYY-MM Age = 6 months old → 2025-09
Full date known YYYY-MM-DD Age = 10 days old → 2026-03-09

Back-Calculation for Display

When deriving birthDate from age, systems should assume the earliest possible date within the known granularity for display purposes:

  • If only the year is known → default to January 1st of that year
  • If only the month and year are known → default to the first day of that month

Important Considerations

  1. Indicate Approximation: Display logic should clearly indicate that the birthDate is approximate when derived from incomplete age information.

  2. Prompt for Updates: Systems should prompt for more precise birth date information when it becomes available.

  3. Avoid Dynamic Age Elements: Do not capture dynamic data (e.g., calculated Age) in static elements or extensions, as these would require server updates to remain current.

  4. Use FHIR Search: The standard FHIR birthDate search parameter is sufficient for filtering patients by age ranges for clinical studies and reporting.

Examples

Scenario Age Input Derived birthDate Notes
2-year-old child "2 years old" 2024 Year only; display as "2024 (approximate)"
6-month-old infant "6 months old" 2025-09 Month and year; display as "September 2025 (approximate)"
10-day-old newborn "10 days old" 2026-03-09 Full date known

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:PHCorePhilHealthID SOΣ 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SOΣ 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣ 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SOΣ 0..1 code Administrative Gender - for backward compatibility with existing implementations
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SOΣ 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:PHCorePhilHealthID SO 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SO 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... name SO 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SO 0..1 code Administrative Gender - for backward compatibility with existing implementations
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SO 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... address SO 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... contact
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... communication
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:PHCorePhilHealthID SOΣ 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SOΣ 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣ 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SOΣ 0..1 code Administrative Gender - for backward compatibility with existing implementations
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SOΣ 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:PHCorePhilHealthID SOΣ 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SOΣ 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣ 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SOΣ 0..1 code Administrative Gender - for backward compatibility with existing implementations
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SOΣ 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... Slices for identifier 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:PHCorePhilHealthID SO 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SO 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... name SO 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SO 0..1 code Administrative Gender - for backward compatibility with existing implementations
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SO 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... address SO 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... contact
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... communication
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... coding SO 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SO 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
.... extension:genderIdentity 0..* (Complex) Gender Identity - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-group
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..1 boolean Indigenous People
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/indigenous-people
.... extension:occupation 0..* (Complex) Occupation
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/occupation
.... extension:race 0..1 CodeableConcept Race
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/race
Binding: Race (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: http://doh.gov.ph/fhir/ph-core/StructureDefinition/educational-attainment
Binding: Educational Attainments (required)
.... extension:sex 0..* (Complex) Sex assigned at birth - in compliance with SOGIE Bill
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:PHCorePhilHealthID SOΣ 0..* PHCorePhilHealthID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... identifier:PHCorePhilSysID SOΣ 0..* PHCorePhilSysID An identifier for this patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SOΣ 0..* PHCoreName A name associated with the patient
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... telecom SOΣ 0..* ContactPoint A contact detail for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... gender SOΣ 0..1 code Administrative Gender - for backward compatibility with existing implementations
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... birthDate SOΣ 0..1 date The date of birth for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SOΣ 0..* PHCoreAddress An address for the individual
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... maritalStatus SO 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship SO 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... name 0..1 PHCoreName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address SO 0..1 PHCoreAddress Address for the contact person
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language SO 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SOΣ 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActor
SHALL:handle PH Core Server
SHALL:handle PH Core Consumer
MAY:able-to-populate PH Core Creator
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron