Draft PH Core Implementation Guide, published by UP Manila National TeleHealth Center. This guide is not an authorized publication; it is the continuous build for version 0.2.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/ph-core/ and changes regularly. See the Directory of published versions
Resource Profile: PH Core RelatedPerson
| Official URL: https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-relatedperson | Version: 0.2.0 | ||||
| Draft as of 2026-05-20 | Computable Name: PHCoreRelatedPerson | ||||
This profile localizes the FHIR R4 RelatedPerson resource to the Philippine context.
Usages:
- Refer to this Profile: PH Core Claim, PH Core Condition, PH Core Encounter, PH Core Medication Administration... Show 9 more
- Examples for this Profile: RelatedPerson/relatedperson-single-example
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
  Slices for identifier |
Σ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | ||||||||||||
   identifier:All Slices |
Content/Rules for all slices | |||||||||||||||
  use |
?!SOΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
| ||||||||||||
 identifier:PHCorePhilHealthID |
SOΣ | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||||||
 use |
?!SOΣ | 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 Fixed Value: http://philhealth.gov.ph/fhir/Identifier/philhealth-id | ||||||||||||
 identifier:PHCorePhilSysID |
SOΣ | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||||||
 use |
?!SOΣ | 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 Fixed Value: http://philsys.gov.ph/fhir/Identifier/philsys-id | ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||||||
 patient |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||||||||||
 relationship |
SOΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
 text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| name |
SOΣ | 0..* | PHCoreName | A name associated with the person
| ||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||||||
| address |
SOΣ | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||||||
 communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||||||
| Slices for identifier |
0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | |||||||||
| identifier:All Slices |
Content/Rules for all slices | |||||||||||
| use |
SO | 0..1 | code | usual | official | temp | secondary | old (If known)
| ||||||||
 identifier:PHCorePhilHealthID |
SO | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||
| identifier:PHCorePhilSysID |
SO | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||
| relationship |
SO | 0..* | CodeableConcept | The nature of the relationship
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| name |
SO | 0..* | PHCoreName | A name associated with the person
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the person
| ||||||||
| address |
SO | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||
| communication |
||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| Slices for identifier |
Σ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | ||||||||||||
| identifier:All Slices |
Content/Rules for all slices | |||||||||||||||
| 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 |
?!SOΣ | 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. | ||||||||||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| 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:PHCorePhilHealthID |
SOΣ | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||||||
| 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 |
?!SOΣ | 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 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: NH | ||||||||||||
| 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 Fixed Value: http://philhealth.gov.ph/fhir/Identifier/philhealth-id | ||||||||||||
| value |
Σ | 0..1 | string | PhilHealth ID Example General: 123456 Example PhilHealth ID: nn-nnnnnnnnn-n | ||||||||||||
| 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:PHCorePhilSysID |
SOΣ | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||||||
| 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 |
?!SOΣ | 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 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: NI | ||||||||||||
| 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 Fixed Value: http://philsys.gov.ph/fhir/Identifier/philsys-id | ||||||||||||
| value |
Σ | 0..1 | string | PhilSys ID Example General: 123456 Example PhilSys ID: 1234-5678-9101-1213 | ||||||||||||
| 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 related person's record is in active use | ||||||||||||
| patient |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||||||||||
| relationship |
SOΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
| ||||||||||||
| 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 |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| name |
SOΣ | 0..* | PHCoreName | A name associated with the person
| ||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||||||
| 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 on which the related person was born | ||||||||||||
| address |
SOΣ | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||||||||||
| 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 |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Summary
Must-Support: 12 elements
Structures
This structure refers to these other structures:
- PIN - PhilHealth Identification Number Identifier (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-philhealth-id)
- PhilSys Identification Number (PhilSys ID) Identifier (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-philsys-id)
- PH Core Name (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-name)
- PH Core Address (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-address)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of RelatedPerson.identifier
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| Slices for identifier |
Σ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | ||||||||||||
| identifier:All Slices |
Content/Rules for all slices | |||||||||||||||
| use |
?!SOΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
| ||||||||||||
| identifier:PHCorePhilHealthID |
SOΣ | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||||||
| use |
?!SOΣ | 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 Fixed Value: http://philhealth.gov.ph/fhir/Identifier/philhealth-id | ||||||||||||
| identifier:PHCorePhilSysID |
SOΣ | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||||||
| use |
?!SOΣ | 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 Fixed Value: http://philsys.gov.ph/fhir/Identifier/philsys-id | ||||||||||||
| active |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||||||||||
| patient |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||||||||||
| relationship |
SOΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| name |
SOΣ | 0..* | PHCoreName | A name associated with the person
| ||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||||||
| address |
SOΣ | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||||||||||
| coding |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||||||
| Slices for identifier |
0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | |||||||||
| identifier:All Slices |
Content/Rules for all slices | |||||||||||
| use |
SO | 0..1 | code | usual | official | temp | secondary | old (If known)
| ||||||||
| identifier:PHCorePhilHealthID |
SO | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||
| identifier:PHCorePhilSysID |
SO | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||
| relationship |
SO | 0..* | CodeableConcept | The nature of the relationship
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| name |
SO | 0..* | PHCoreName | A name associated with the person
| ||||||||
| telecom |
SO | 0..* | ContactPoint | A contact detail for the person
| ||||||||
| address |
SO | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||
| communication |
||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health
| ||||||||
| coding |
SO | 0..* | Coding | Code defined by a terminology system
| ||||||||
| text |
SO | 0..1 | string | Plain text representation of the concept
| ||||||||
| Documentation for this format | ||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| Slices for identifier |
Σ | 0..* | Identifier | A human identifier for this person Slice: Unordered, Open by value:system | ||||||||||||
| identifier:All Slices |
Content/Rules for all slices | |||||||||||||||
| 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 |
?!SOΣ | 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. | ||||||||||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| 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:PHCorePhilHealthID |
SOΣ | 0..* | PHCorePhilHealthID | A human identifier for this person
| ||||||||||||
| 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 |
?!SOΣ | 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 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: NH | ||||||||||||
| 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 Fixed Value: http://philhealth.gov.ph/fhir/Identifier/philhealth-id | ||||||||||||
| value |
Σ | 0..1 | string | PhilHealth ID Example General: 123456 Example PhilHealth ID: nn-nnnnnnnnn-n | ||||||||||||
| 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:PHCorePhilSysID |
SOΣ | 0..* | PHCorePhilSysID | A human identifier for this person
| ||||||||||||
| 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 |
?!SOΣ | 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 | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: NI | ||||||||||||
| 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 Fixed Value: http://philsys.gov.ph/fhir/Identifier/philsys-id | ||||||||||||
| value |
Σ | 0..1 | string | PhilSys ID Example General: 123456 Example PhilSys ID: 1234-5678-9101-1213 | ||||||||||||
| 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 related person's record is in active use | ||||||||||||
| patient |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||||||||||
| relationship |
SOΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
| ||||||||||||
| 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 |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| name |
SOΣ | 0..* | PHCoreName | A name associated with the person
| ||||||||||||
| telecom |
SOΣ | 0..* | ContactPoint | A contact detail for the person
| ||||||||||||
| 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 on which the related person was born | ||||||||||||
| address |
SOΣ | 0..* | PHCoreAddress | Address where the related person can be contacted or visited
| ||||||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
| language |
SO | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| ||||||||||||
| 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 |
SOΣ | 0..* | Coding | Code defined by a terminology system
| ||||||||||||
| text |
SOΣ | 0..1 | string | Plain text representation of the concept
| ||||||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilHealthID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:PHCorePhilSysID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍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()
|
| Name | PH Core Creator | PH Core Server | PH Core Consumer |
|---|---|---|---|
| RelatedPerson |
|||
| Slices for identifier |
|||
| identifier:All Slices |
|||
| use |
|
|
|
| identifier:PHCorePhilHealthID |
|
|
|
| use |
|
|
|
| identifier:PHCorePhilSysID |
|
|
|
| use |
|
|
|
| relationship |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| name |
|
|
|
| telecom |
|
|
|
| address |
|
|
|
| communication |
|||
| language |
|
|
|
| coding |
|
|
|
| text |
|
|
|
| Documentation for this format | |||
Summary
Must-Support: 12 elements
Structures
This structure refers to these other structures:
- PIN - PhilHealth Identification Number Identifier (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-philhealth-id)
- PhilSys Identification Number (PhilSys ID) Identifier (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-philsys-id)
- PH Core Name (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-name)
- PH Core Address (https://fhir.doh.gov.ph/phcore/StructureDefinition/ph-core-address)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of RelatedPerson.identifier
Other representations of profile: CSV, Excel, Schematron