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 Person

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

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

Demographics and administrative information about a person independent of a specific health-related context.

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
Person 0..* Person A generic person record
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.address 0..* PH_Address One or more addresses for the person

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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 Person

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.meta
Person.meta.Slices for extension Content/Rules for all slices
Person.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
Person.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
Person.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Person.implicitRules 0..0 A set of rules under which this content was created
Person.language 0..0 Language of the resource content
Person.contained 0..0 Contained, inline Resources
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.modifierExtension 0..0 Extension
Person.name
Person.name.id 0..0 Unique id for inter-element referencing
Person.name.extension 0..0 Extension
Person.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Person.name.text 0..0 Text representation of the full name
Person.name.prefix 0..0 Parts that come before the name
Person.name.period 0..0 Time period when name was/is in use
Person.telecom
Person.telecom.id 0..0 Unique id for inter-element referencing
Person.telecom.extension 0..0 Extension
Person.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Person.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Person.telecom.period 0..0 Time period when the contact point was/is in use
Person.gender 0..0 male | female | other | unknown
Person.address 0..* PH_Address One or more addresses for the person
Person.photo 0..0 Image of the person
Person.managingOrganization 0..0 The organization that is the custodian of the person record
Person.active 0..0 This person's record is in active use
Person.link
Person.link.id 0..0 Unique id for inter-element referencing
Person.link.extension 0..0 Extension
Person.link.modifierExtension 0..0 Extension
Person.link.target 1..1 Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) The resource to which this actual person is associated
Person.link.assurance 0..0 level1 | level2 | level3 | level4

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.id This element is included in summaries. 0..1 id Logical id of this artifact
Person.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Person.meta.id 0..1 string Unique id for inter-element referencing
Person.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Person.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
Person.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
Person.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Person.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Person.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Person.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Person.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.
Person.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".
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.identifier 0..* Identifier A human identifier for this person
Person.name This element is included in summaries. 0..* HumanName A name associated with the person
Person.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
Person.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Person.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
Person.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
Person.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
Person.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
Person.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.
Person.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Person.birthDate This element is included in summaries. 0..1 date The date on which the person was born
Person.address 0..* PH_Address One or more addresses for the person
Person.link 0..* BackboneElement Link to a resource that concerns the same actual person
Person.link.target 1..1 Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) The resource to which this actual person is associated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.address 0..* PH_Address One or more addresses for the person

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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 Person

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.meta
Person.meta.Slices for extension Content/Rules for all slices
Person.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
Person.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
Person.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Person.implicitRules 0..0 A set of rules under which this content was created
Person.language 0..0 Language of the resource content
Person.text 0..0 Text summary of the resource, for human interpretation
Person.contained 0..0 Contained, inline Resources
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.modifierExtension 0..0 Extension
Person.name
Person.name.id 0..0 Unique id for inter-element referencing
Person.name.extension 0..0 Extension
Person.name.use 0..0 usual | official | temp | nickname | anonymous | old | maiden
Person.name.text 0..0 Text representation of the full name
Person.name.prefix 0..0 Parts that come before the name
Person.name.period 0..0 Time period when name was/is in use
Person.telecom
Person.telecom.id 0..0 Unique id for inter-element referencing
Person.telecom.extension 0..0 Extension
Person.telecom.use 0..0 home | work | temp | old | mobile - purpose of this contact point
Person.telecom.rank 0..0 Specify preferred order of use (1 = highest)
Person.telecom.period 0..0 Time period when the contact point was/is in use
Person.gender 0..0 male | female | other | unknown
Person.address 0..* PH_Address One or more addresses for the person
Person.photo 0..0 Image of the person
Person.managingOrganization 0..0 The organization that is the custodian of the person record
Person.active 0..0 This person's record is in active use
Person.link
Person.link.id 0..0 Unique id for inter-element referencing
Person.link.extension 0..0 Extension
Person.link.modifierExtension 0..0 Extension
Person.link.target 1..1 Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) The resource to which this actual person is associated
Person.link.assurance 0..0 level1 | level2 | level3 | level4

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Person 0..* Person A generic person record
Person.id This element is included in summaries. 0..1 id Logical id of this artifact
Person.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Person.meta.id 0..1 string Unique id for inter-element referencing
Person.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Person.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
Person.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
Person.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Person.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Person.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Person.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Person.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.
Person.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".
Person.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
Person.Slices for extension.extension:sex 0..1 code Sex at birth
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex
Binding: Sex (required): Sex ValueSet
Person.Slices for extension.extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
Person.Slices for extension.extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Person.identifier 0..* Identifier A human identifier for this person
Person.name This element is included in summaries. 0..* HumanName A name associated with the person
Person.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
Person.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Person.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
Person.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
Person.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
Person.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
Person.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.
Person.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Person.birthDate This element is included in summaries. 0..1 date The date on which the person was born
Person.address 0..* PH_Address One or more addresses for the person
Person.link 0..* BackboneElement Link to a resource that concerns the same actual person
Person.link.target 1..1 Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) The resource to which this actual person is associated

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Person.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Person.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 Person 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 Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person 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()

 

Other representations of profile: CSV, Excel, Schematron