DHIN 2025Connectathon FHIR IG
0.1.0 - draft
DHIN 2025Connectathon FHIR IG, published by DHIN. 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/Nigeria-FHIR-Community/2025Connectathon/ and changes regularly. See the Directory of published versions
| Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/related-person | Version: 0.1.0 | |||
| Draft as of 2025-10-21 | Computable Name: NgRelatedPerson | |||
Sibling or parent of the sick person.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
SΣ | 1..1 | Reference(NG Patient) | The client this person is related to |
![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
Σ | 0..1 | string | The surname of Client's related person |
![]() ![]() ![]() |
Σ | 1..* | string | The first name and other names of Client's related person This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() |
Σ | 0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) |
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
| 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())
|
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
S | 1..1 | Reference(NG Patient) | The client this person is related to |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | string | The relationship of the sibling with the Client e.g. brother| sister Binding: NG Sibling Relationships VS (extensible) | |
![]() ![]() |
S | 1..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | string | The surname of Client's related person | |
![]() ![]() ![]() |
1..* | string | The first name and other names of Client's related person | |
![]() ![]() |
0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) | |
![]() ![]() |
S | 0..1 | date | The date on which the related person was born |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship.text | Base | extensible | NG Sibling Relationships VS | 📦0.1.0 | This IG |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
SΣ | 1..1 | Reference(NG Patient) | The client this person is related to | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The relationship of the sibling with the Client e.g. brother| sister Binding: NG Sibling Relationships VS (extensible) | ||||
![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The surname of Client's related person | ||||
![]() ![]() ![]() |
Σ | 1..* | string | The first name and other names of Client's related person This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) | ||||
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship.text | Base | extensible | NG Sibling Relationships VS | 📦0.1.0 | This IG |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
SΣ | 1..1 | Reference(NG Patient) | The client this person is related to |
![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
Σ | 0..1 | string | The surname of Client's related person |
![]() ![]() ![]() |
Σ | 1..* | string | The first name and other names of Client's related person This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() |
Σ | 0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) |
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
| 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())
|
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
S | 1..1 | Reference(NG Patient) | The client this person is related to |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | string | The relationship of the sibling with the Client e.g. brother| sister Binding: NG Sibling Relationships VS (extensible) | |
![]() ![]() |
S | 1..* | HumanName | A name associated with the person |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..1 | string | The surname of Client's related person | |
![]() ![]() ![]() |
1..* | string | The first name and other names of Client's related person | |
![]() ![]() |
0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) | |
![]() ![]() |
S | 0..1 | date | The date on which the related person was born |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship.text | Base | extensible | NG Sibling Relationships VS | 📦0.1.0 | This IG |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
SΣ | 1..1 | Reference(NG Patient) | The client this person is related to | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The relationship of the sibling with the Client e.g. brother| sister Binding: NG Sibling Relationships VS (extensible) | ||||
![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the person | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The surname of Client's related person | ||||
![]() ![]() ![]() |
Σ | 1..* | string | The first name and other names of Client's related person This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | The sex of the Immunization client's related person Binding: NG Gender or Sex VS (required) | ||||
![]() ![]() |
SΣ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
Σ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..1 | Period | Period of time that this relationship is considered valid | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship.text | Base | extensible | NG Sibling Relationships VS | 📦0.1.0 | This IG |
| RelatedPerson.gender | Base | required | NG Gender or Sex VS | 📦0.1.0 | This IG |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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
Other representations of profile: CSV, Excel, Schematron