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/PROJ-PHILHEALTH-EA-NHDR/nhdr-fhir-ig-review-project-2/ 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:

- Refer to this Profile: PH Person

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Person |  | 0..* | Person | A generic person record
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sex |  | 0..1 | code | Sex at birth URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex Binding: Sex (required): Sex ValueSet
extension:maritalStatus |  | 0..* | CodeableConcept | Marital Status URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus Binding: Marital Status Codes (required)
extension:nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
address |  | 0..* | PH_Address | One or more addresses for the person
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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Person |  | 0..* | Person | A generic person record
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:sex |  | 0..1 | code | Sex at birth URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex Binding: Sex (required): Sex ValueSet
extension:maritalStatus |  | 0..* | CodeableConcept | Marital Status URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus Binding: Marital Status Codes (required)
extension:nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
identifier |  | 0..* | Identifier | A human identifier for this person
name | Σ | 0..* | HumanName | A name associated with the person
extension |  | 0..0 |  | Extension 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..0 |  | Extension 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
birthDate | Σ | 0..1 | date | The date on which the person was born
address |  | 0..* | PH_Address | One or more addresses for the person
link |  | 0..* | BackboneElement | Link to a resource that concerns the same actual person
target |  | 1..1 | Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) | The resource to which this actual person is associated
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()`

This structure is derived from Person

Summary

Prohibited: 24 elements

Structures

This structure refers to these other structures:

- PH Address (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Address)
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH RelatedPerson (https://nhdr.gov.ph/fhir/StructureDefinition/PH-RelatedPerson)
- PH Person (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Person)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
- https://nhdr.gov.ph/fhir/StructureDefinition/Sex
- https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
- http://hl7.org/fhir/StructureDefinition/patient-nationality

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Person |  | 0..* | Person | A generic person record
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:sex |  | 0..1 | code | Sex at birth URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex Binding: Sex (required): Sex ValueSet
extension:maritalStatus |  | 0..* | CodeableConcept | Marital Status URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus Binding: Marital Status Codes (required)
extension:nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
address |  | 0..* | PH_Address | One or more addresses for the person
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

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Person |  | 0..* | Person | A generic person record
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:sex |  | 0..1 | code | Sex at birth URL: https://nhdr.gov.ph/fhir/StructureDefinition/Sex Binding: Sex (required): Sex ValueSet
extension:maritalStatus |  | 0..* | CodeableConcept | Marital Status URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus Binding: Marital Status Codes (required)
extension:nationality |  | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
identifier |  | 0..* | Identifier | A human identifier for this person
name | Σ | 0..* | HumanName | A name associated with the person
extension |  | 0..0 |  | Extension 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..0 |  | Extension 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
birthDate | Σ | 0..1 | date | The date on which the person was born
address |  | 0..* | PH_Address | One or more addresses for the person
link |  | 0..* | BackboneElement | Link to a resource that concerns the same actual person
target |  | 1..1 | Reference(PH Patient | PH Practitioner | PH RelatedPerson | PH Person) | The resource to which this actual person is associated
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()`

This structure is derived from Person

Summary

Prohibited: 24 elements

Structures

This structure refers to these other structures:

- PH Address (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Address)
- PH Patient (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Patient)
- PH Practitioner (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Practitioner)
- PH RelatedPerson (https://nhdr.gov.ph/fhir/StructureDefinition/PH-RelatedPerson)
- PH Person (https://nhdr.gov.ph/fhir/StructureDefinition/PH-Person)

Extensions

This structure refers to these extensions:

- https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
- https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
- https://nhdr.gov.ph/fhir/StructureDefinition/Sex
- https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
- http://hl7.org/fhir/StructureDefinition/patient-nationality

Other representations of profile: CSV, Excel, Schematron