NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Resource Profile: PH Patient

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient Version: 0.1.0
Standards status: Draft Computable Name: PH_Patient

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

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

This is a sample use of -intro.md

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: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:religion.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.Slices for identifier This element is included in summaries. C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PhilHealthID.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value This element is included in summaries. C 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
Patient.Slices for identifier.identifier:PDD This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PDD.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:TIN This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:SSS-GSIS This element is included in summaries. 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSS-GSIS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:DriversLicense This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:DriversLicense.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:PassportNumber This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PassportNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier:PhilHealthID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦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
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()
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()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.meta
Patient.meta.Slices for extension Content/Rules for all slices
Patient.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Patient.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Patient.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Patient.implicitRules 0..0 A set of rules under which this content was created
Patient.language 0..0 Language of the resource content
Patient.contained 0..0 Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.modifierExtension 0..0 Extension
Patient.Slices for identifier C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.type
Patient.Slices for identifier.identifier:PhilHealthID.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
Patient.Slices for identifier.identifier:PhilHealthID.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value C 0..1 string The value that is unique
Constraints: PH-00001
Patient.Slices for identifier.identifier:PDD 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.type
Patient.Slices for identifier.identifier:PDD.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PDD.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
Patient.Slices for identifier.identifier:PDD.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:TIN 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.type
Patient.Slices for identifier.identifier:TIN.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:TIN.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
Patient.Slices for identifier.identifier:TIN.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:SSS-GSIS 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.type
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
Patient.Slices for identifier.identifier:SSS-GSIS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:DriversLicense 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.type
Patient.Slices for identifier.identifier:DriversLicense.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:DriversLicense.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
Patient.Slices for identifier.identifier:DriversLicense.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:PassportNumber 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.type
Patient.Slices for identifier.identifier:PassportNumber.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PassportNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
Patient.Slices for identifier.identifier:PassportNumber.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.name
Patient.name.id 0..0 Unique id for inter-element referencing
Patient.name.extension 0..0 Extension
Patient.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text 0..0 Text representation of the full name
Patient.name.prefix 0..0 Parts that come before the name
Patient.name.period 0..0 Time period when name was/is in use
Patient.telecom
Patient.telecom.id 0..0 Unique id for inter-element referencing
Patient.telecom.extension 0..0 Extension
Patient.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Patient.telecom.period 0..0 Time period when the contact point was/is in use
Patient.address 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.contact
Patient.contact.modifierExtension 0..0 Extension
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
Patient.contact.name
Patient.contact.name.id 0..0 Unique id for inter-element referencing
Patient.contact.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.text 0..0 Text representation of the full name
Patient.contact.name.prefix 0..0 Parts that come before the name
Patient.contact.name.period 0..0 Time period when name was/is in use
Patient.contact.telecom
Patient.contact.telecom.id 0..0 Unique id for inter-element referencing
Patient.contact.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.contact.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Patient.contact.telecom.period 0..0 Time period when the contact point was/is in use
Patient.contact.address 0..1 PH_Address Address for the contact person
Patient.contact.gender 0..0 male | female | other | unknown
Patient.contact.organization 0..0 Organization that is associated with the contact
Patient.contact.period 0..0 The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider
Patient.managingOrganization 0..0 Organization that is the custodian of the patient record
Patient.link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Patient.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:religion.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:religion.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.Slices for identifier This element is included in summaries. C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhilHealthID.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PhilHealthID.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PhilHealthID.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhilHealthID.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PhilHealthID.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PhilHealthID.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value This element is included in summaries. C 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
Patient.Slices for identifier.identifier:PhilHealthID.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PhilHealthID.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PDD This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PDD.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PDD.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PDD.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PDD.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PDD.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PDD.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PDD.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PDD.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
Patient.Slices for identifier.identifier:PDD.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PDD.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PDD.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PDD.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:PDD.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PDD.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PDD.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:TIN This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TIN.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:TIN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TIN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:TIN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:TIN.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:TIN.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:TIN.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
Patient.Slices for identifier.identifier:TIN.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:TIN.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:TIN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:TIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:TIN.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:TIN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:TIN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSS-GSIS This element is included in summaries. 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSS-GSIS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSS-GSIS.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:SSS-GSIS.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:SSS-GSIS.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:SSS-GSIS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:SSS-GSIS.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:SSS-GSIS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSS-GSIS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:DriversLicense This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:DriversLicense.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:DriversLicense.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:DriversLicense.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:DriversLicense.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:DriversLicense.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:DriversLicense.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:DriversLicense.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:DriversLicense.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
Patient.Slices for identifier.identifier:DriversLicense.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:DriversLicense.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:DriversLicense.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:DriversLicense.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:DriversLicense.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:DriversLicense.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:DriversLicense.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PassportNumber This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PassportNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PassportNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PassportNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PassportNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PassportNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PassportNumber.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PassportNumber.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PassportNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
Patient.Slices for identifier.identifier:PassportNumber.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PassportNumber.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PassportNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PassportNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.Slices for identifier.identifier:PassportNumber.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PassportNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PassportNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.name.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.contact.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.contact.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Patient.contact.address 0..1 PH_Address Address for the contact person
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier:PhilHealthID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PhilHealthID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍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.telecom.​system Base required ContactPointSystem 📍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
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()
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: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:religion.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.Slices for identifier This element is included in summaries. C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PhilHealthID.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value This element is included in summaries. C 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
Patient.Slices for identifier.identifier:PDD This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PDD.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:TIN This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:SSS-GSIS This element is included in summaries. 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSS-GSIS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:DriversLicense This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:DriversLicense.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:PassportNumber This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PassportNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier:PhilHealthID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required MaritalStatus 📦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
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()
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()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.meta
Patient.meta.Slices for extension Content/Rules for all slices
Patient.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Patient.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Patient.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Patient.implicitRules 0..0 A set of rules under which this content was created
Patient.language 0..0 Language of the resource content
Patient.text 0..0 Text summary of the resource, for human interpretation
Patient.contained 0..0 Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.modifierExtension 0..0 Extension
Patient.Slices for identifier C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.type
Patient.Slices for identifier.identifier:PhilHealthID.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
Patient.Slices for identifier.identifier:PhilHealthID.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value C 0..1 string The value that is unique
Constraints: PH-00001
Patient.Slices for identifier.identifier:PDD 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.type
Patient.Slices for identifier.identifier:PDD.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PDD.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
Patient.Slices for identifier.identifier:PDD.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:TIN 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.type
Patient.Slices for identifier.identifier:TIN.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:TIN.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
Patient.Slices for identifier.identifier:TIN.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:SSS-GSIS 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.type
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
Patient.Slices for identifier.identifier:SSS-GSIS.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:DriversLicense 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.type
Patient.Slices for identifier.identifier:DriversLicense.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:DriversLicense.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
Patient.Slices for identifier.identifier:DriversLicense.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:PassportNumber 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.type
Patient.Slices for identifier.identifier:PassportNumber.type.coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
Patient.Slices for identifier.identifier:PassportNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
Patient.Slices for identifier.identifier:PassportNumber.system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.name
Patient.name.id 0..0 Unique id for inter-element referencing
Patient.name.extension 0..0 Extension
Patient.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text 0..0 Text representation of the full name
Patient.name.prefix 0..0 Parts that come before the name
Patient.name.period 0..0 Time period when name was/is in use
Patient.telecom
Patient.telecom.id 0..0 Unique id for inter-element referencing
Patient.telecom.extension 0..0 Extension
Patient.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Patient.telecom.period 0..0 Time period when the contact point was/is in use
Patient.address 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.multipleBirth[x] 0..0 Whether patient is part of a multiple birth
Patient.contact
Patient.contact.modifierExtension 0..0 Extension
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
Patient.contact.name
Patient.contact.name.id 0..0 Unique id for inter-element referencing
Patient.contact.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.text 0..0 Text representation of the full name
Patient.contact.name.prefix 0..0 Parts that come before the name
Patient.contact.name.period 0..0 Time period when name was/is in use
Patient.contact.telecom
Patient.contact.telecom.id 0..0 Unique id for inter-element referencing
Patient.contact.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Patient.contact.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Patient.contact.telecom.period 0..0 Time period when the contact point was/is in use
Patient.contact.address 0..1 PH_Address Address for the contact person
Patient.contact.gender 0..0 male | female | other | unknown
Patient.contact.organization 0..0 Organization that is associated with the contact
Patient.contact.period 0..0 The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..0 A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider
Patient.managingOrganization 0..0 Organization that is the custodian of the patient record
Patient.link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.maritalStatus Base required MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base required Patient relationship type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* Patient Information about an individual receiving health care services
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.meta.id 0..1 string Unique id for inter-element referencing
Patient.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Patient.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Patient.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Patient.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Patient.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Patient.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Patient.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Patient.Slices for extension.extension:religion.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:religion.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:religion.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
Patient.Slices for extension.extension:religion.value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
Patient.Slices for extension.extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
Patient.Slices for extension.extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
Patient.Slices for extension.extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
Patient.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Patient.Slices for extension.extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
Patient.Slices for extension.extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
Patient.Slices for extension.extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
Patient.Slices for extension.extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
Patient.Slices for identifier This element is included in summaries. C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:PhilHealthID This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PhilHealthID.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhilHealthID.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PhilHealthID.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PhilHealthID.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PhilHealthID.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PhilHealthID.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PhilHealthID.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PhilHealthID.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
Patient.Slices for identifier.identifier:PhilHealthID.value This element is included in summaries. C 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
Patient.Slices for identifier.identifier:PhilHealthID.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PhilHealthID.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PDD This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PDD.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PDD.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PDD.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PDD.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PDD.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PDD.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PDD.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PDD.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PDD.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PDD.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
Patient.Slices for identifier.identifier:PDD.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PDD.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PDD.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PDD.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
Patient.Slices for identifier.identifier:PDD.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PDD.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PDD.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:TIN This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:TIN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TIN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:TIN.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:TIN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:TIN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:TIN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:TIN.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:TIN.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:TIN.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:TIN.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
Patient.Slices for identifier.identifier:TIN.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:TIN.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:TIN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:TIN.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
Patient.Slices for identifier.identifier:TIN.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:TIN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:TIN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSS-GSIS This element is included in summaries. 0..2 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:SSS-GSIS.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSS-GSIS.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSS-GSIS.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:SSS-GSIS.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:SSS-GSIS.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:SSS-GSIS.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:SSS-GSIS.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
Patient.Slices for identifier.identifier:SSS-GSIS.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:SSS-GSIS.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSS-GSIS.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:DriversLicense This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:DriversLicense.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:DriversLicense.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:DriversLicense.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:DriversLicense.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:DriversLicense.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:DriversLicense.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:DriversLicense.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:DriversLicense.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:DriversLicense.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:DriversLicense.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
Patient.Slices for identifier.identifier:DriversLicense.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:DriversLicense.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:DriversLicense.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:DriversLicense.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
Patient.Slices for identifier.identifier:DriversLicense.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:DriversLicense.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:DriversLicense.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:PassportNumber This element is included in summaries. 0..1 Identifier An identifier for this patient
Patient.Slices for identifier.identifier:PassportNumber.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PassportNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:PassportNumber.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:PassportNumber.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:PassportNumber.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
Patient.Slices for identifier.identifier:PassportNumber.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:PassportNumber.type.coding.extension 0..* Extension Additional content defined by implementations
Patient.Slices for identifier.identifier:PassportNumber.type.coding.system 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:PassportNumber.type.coding.version 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:PassportNumber.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
Patient.Slices for identifier.identifier:PassportNumber.type.coding.display 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:PassportNumber.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:PassportNumber.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:PassportNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
Patient.Slices for identifier.identifier:PassportNumber.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Patient.Slices for identifier.identifier:PassportNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:PassportNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element is included in summaries. 0..* HumanName A name associated with the patient
Patient.name.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Patient.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate This element is included in summaries. 0..1 date The date of birth for the individual
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element is included in summaries. 0..* PH_Address An address for the individual
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Patient.contact.name.given This element is included in summaries. 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.contact.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.contact.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Patient.contact.address 0..1 PH_Address Address for the contact person
Patient.generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.extension:religion.​value[x] Base required ReligiousAffiliation 📦3.0.0 THO v7.4
Patient.identifier:PhilHealthID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PhilHealthID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PDD.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:TIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSS-GSIS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:DriversLicense.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:PassportNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍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.telecom.​system Base required ContactPointSystem 📍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
PH-00001 error Patient.identifier:PhilHealthID.value Not a valid PIN format. matches('^[0-9]{2}-[0-9]{9}-[0-9]{1}$')
PH-00002 error Patient.identifier Identifier.system must be identified. system.exists()
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

Notes:

This is a sample use of -notes.md