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 RelatedPerson

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

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

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

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
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... address Σ 0..* PH_Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... modifierExtension 0..0 Extension
... active 0..0 Whether this related person's record is in active use
... 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 Address where the related person can be contacted or visited
... photo 0..0 Image of the person
... period 0..0 Period of time that this relationship is considered valid
... communication 0..0 A language which may be used to communicate with about the patient's health

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... relationship Σ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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 related person was born
... address Σ 0..* PH_Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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 RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... address Σ 0..* PH_Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... modifierExtension 0..0 Extension
... active 0..0 Whether this related person's record is in active use
... 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 Address where the related person can be contacted or visited
... photo 0..0 Image of the person
... period 0..0 Period of time that this relationship is considered valid
... communication 0..0 A language which may be used to communicate with about the patient's health

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... 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:occupation 0..* CodeableConcept Occupation / In Years
URL: https://nhdr.gov.ph/fhir/StructureDefinition/Occupation
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:maritalStatus 0..* CodeableConcept Marital Status
URL: https://nhdr.gov.ph/fhir/StructureDefinition/MaritalStatus
Binding: Marital Status Codes (required)
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... relationship Σ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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 related person was born
... address Σ 0..* PH_Address Address where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

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