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/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:

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
... 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

PathConformanceValueSetURI
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson RelatedPerson
... implicitRules 0..0
... language 0..0
... text 0..0
... 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
... modifierExtension 0..0
... active 0..0
... relationship 0..0
... 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
... gender 0..0
... address 0..* PH_Address Address where the related person can be contacted or visited
... photo 0..0
... period 0..0
... communication 0..0

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
... 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
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... name Σ 0..* HumanName A name associated with the person
.... 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 person
.... 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
... 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

PathConformanceValueSetURI
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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
... 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

PathConformanceValueSetURI
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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 RelatedPerson
... implicitRules 0..0
... language 0..0
... text 0..0
... 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
... modifierExtension 0..0
... active 0..0
... relationship 0..0
... 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
... gender 0..0
... address 0..* PH_Address Address where the related person can be contacted or visited
... photo 0..0
... period 0..0
... communication 0..0

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
... 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
... patient Σ 1..1 Reference(Patient) The patient this person is related to
... name Σ 0..* HumanName A name associated with the person
.... 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 person
.... 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
... 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

PathConformanceValueSetURI
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from RelatedPerson

Summary

Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron