HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzRelatedPerson | Version: 1.0.0 | |||
| Active as of 2026-08-04 | Computable Name: NzRelatedPerson | |||
The base New Zealand RelatedPerson profile
Describe the Base New Zealand RelatedPerson resource profile
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient this person is related to |
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | NZ Relationship Type | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
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..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | NZ Relationship Type | 📦1.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 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
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..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) | ||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 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 | NZ Relationship Type | 📦1.1.0 | This IG |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient this person is related to |
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | NZ Relationship Type | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
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..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | NZ Relationship Type | 📦1.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 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
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..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The nature of the relationship Binding: NZ Relationship Type (preferred) | ||||
![]() ![]() |
Σ | 0..* | HumanName | A name associated with the person | ||||
![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 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 | NZ Relationship Type | 📦1.1.0 | This IG |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from RelatedPerson
Other representations of profile: CSV, Excel, Schematron