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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
... Slices for identifier ΣC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
.... identifier:PhilHealthID Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value ΣC 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
.... identifier:PDD Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
.... identifier:TIN Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
.... identifier:SSS-GSIS Σ 0..2 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
.... identifier:DriversLicense Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
.... identifier:PassportNumber Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... 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 v6.5
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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... meta
.... Slices for extension Content/Rules for all slices
..... 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
..... 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
.... lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
... implicitRules 0..0
... language 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
... modifierExtension 0..0
... Slices for identifier C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
.... identifier:PhilHealthID 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value C 0..1 string The value that is unique
Constraints: PH-00001
.... identifier:PDD 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
.... identifier:TIN 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
.... identifier:SSS-GSIS 0..2 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
.... identifier:DriversLicense 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
.... identifier:PassportNumber 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
... name
.... id 0..0
.... extension 0..0
.... use 0..0
.... text 0..0
.... prefix 0..0
.... period 0..0
... telecom
.... id 0..0
.... extension 0..0
.... use 0..0
.... rank 0..0
.... period 0..0
... address 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..0
... contact
.... modifierExtension 0..0
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
.... name
..... id 0..0
..... use 0..0
..... text 0..0
..... prefix 0..0
..... period 0..0
.... telecom
..... id 0..0
..... use 0..0
..... rank 0..0
..... period 0..0
.... address 0..1 PH_Address Address for the contact person
.... gender 0..0
.... organization 0..0
.... period 0..0
... communication 0..0
... generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider
... managingOrganization 0..0
... link 0..0

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 v6.5
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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
..... 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
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource was uploaded to the NHDR.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
.... identifier:PhilHealthID Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value ΣC 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PDD Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TIN Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SSS-GSIS Σ 0..2 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:DriversLicense Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PassportNumber Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... extension 0..0
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... extension 0..0
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 0..1 string The actual contact point details
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
.... name 0..1 HumanName A name associated with the contact person
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 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
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... telecom 0..* ContactPoint A contact detail for the person
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The actual contact point details
.... address 0..1 PH_Address Address for the contact person
... 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 v6.5
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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
... Slices for identifier ΣC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
.... identifier:PhilHealthID Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value ΣC 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
.... identifier:PDD Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
.... identifier:TIN Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
.... identifier:SSS-GSIS Σ 0..2 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
.... identifier:DriversLicense Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
.... identifier:PassportNumber Σ 0..1 Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... 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 v6.5
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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... meta
.... Slices for extension Content/Rules for all slices
..... 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
..... 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
.... lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
... implicitRules 0..0
... language 0..0
... contained 0..0
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
... modifierExtension 0..0
... Slices for identifier C 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: PH-00002
.... identifier:PhilHealthID 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value C 0..1 string The value that is unique
Constraints: PH-00001
.... identifier:PDD 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
.... identifier:TIN 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
.... identifier:SSS-GSIS 0..2 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
.... identifier:DriversLicense 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
.... identifier:PassportNumber 0..1 Identifier An identifier for this patient
..... type
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
... name
.... id 0..0
.... extension 0..0
.... use 0..0
.... text 0..0
.... prefix 0..0
.... period 0..0
... telecom
.... id 0..0
.... extension 0..0
.... use 0..0
.... rank 0..0
.... period 0..0
... address 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..0
... contact
.... modifierExtension 0..0
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
.... name
..... id 0..0
..... use 0..0
..... text 0..0
..... prefix 0..0
..... period 0..0
.... telecom
..... id 0..0
..... use 0..0
..... rank 0..0
..... period 0..0
.... address 0..1 PH_Address Address for the contact person
.... gender 0..0
.... organization 0..0
.... period 0..0
... communication 0..0
... generalPractitioner 0..* Reference(PH Organization) Patient's nominated primary care provider
... managingOrganization 0..0
... link 0..0

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 v6.5
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: Filtersdoco
.. Patient 0..* Patient Information about an individual receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
..... 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
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource was uploaded to the NHDR.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:religion 0..* (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: ReligiousAffiliation (required)
.... extension:indigenousGroup 0..* CodeableConcept Indigenous Group
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousGroup
Binding: Indigenous Groups (required)
.... extension:indigenousPeople 0..* boolean Philippine Indigenous Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/IndigenousPeople
.... extension:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
.... extension:race 0..1 CodeableConcept Race
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Race
Binding: Race (required): Race ValueSet
.... extension:memberType 0..1 CodeableConcept Member Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MemberType
Binding: Member Type (required)
.... extension:type 0..1 CodeableConcept Patient Type
URL: https://nhdr.gov.ph/fhir/StructureDefinition/PatientType
Binding: Patient Type (required)
.... extension:educationalAttainment 0..1 CodeableConcept Educational Attainment
URL: https://nhdr.gov.ph/fhir/StructureDefinition/EducationalAttainment
Binding: Educational Attainment (required)
.... identifier:PhilHealthID Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NIIP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/philhealth-id
..... value ΣC 0..1 string The value that is unique
Constraints: PH-00001
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PDD Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PDD
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/pdd-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TIN Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: TAX
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/tin-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SSS-GSIS Σ 0..2 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SB
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/sss-gsis-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:DriversLicense Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: DL
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/driverslicense
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PassportNumber Σ 0..1 Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://nhdr.gov.ph/fhir/Identifier/passportnumber
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... extension 0..0
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... extension 0..0
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 0..1 string The actual contact point details
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* PH_Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required)
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientRelationshipType (required)
.... name 0..1 HumanName A name associated with the contact person
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 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
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... telecom 0..* ContactPoint A contact detail for the person
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value Σ 0..1 string The actual contact point details
.... address 0..1 PH_Address Address for the contact person
... 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 v6.5
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