Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.28.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.28.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: AIRRelatedPersonPrf - Detailed Descriptions

Active as of 2026-08-04

Definitions for the air-related-person-prf resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. RelatedPerson
Definition | 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.
Short | A person that is related to a patient, but who is not a direct target of care
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. RelatedPerson.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. RelatedPerson.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. RelatedPerson.active
Definition | Whether this related person record is in active use.
Short | Whether this related person's record is in active use
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Control | 0..1
Type | boolean
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. RelatedPerson.patient
Definition | The patient this person is related to.
Short | The patient this person is related to
Control | 1..1
Type | Reference(Patient)
Is Modifier | false
Summary | true
Requirements | We need to know which patient this RelatedPerson is related to.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. RelatedPerson.relationship
Definition | The nature of the relationship between a patient and the related person.
Short | The nature of the relationship
Control | 0..*
Binding | The codes SHOULD be taken from AIR Related Person Relationship Code http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 (preferred to `https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. RelatedPerson.gender
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Short | male | female | other | unknown
Control | 0..01
Binding | The codes SHALL be taken from AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 (required to `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` ) The gender of a person used for administrative purposes.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed for identification of the person, in combination with (at least) name and birth date.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. RelatedPerson.birthDate
Definition | The date on which the related person was born.
Short | The date on which the related person was born
Control | 0..01
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. RelatedPerson.address
Definition | Address where the related person can be contacted or visited.
Short | Address where the related person can be contacted or visited
Control | 0..*
Type | Address(Common NZ Address datatype)
Is Modifier | false
Summary | true
Requirements | Need to keep track where the related person can be contacted per postal mail or visited.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. RelatedPerson.photo
Definition | Image of the person.
Short | Image of the person
Control | 0..0*
Type | Attachment
Is Modifier | false
Summary | false
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. RelatedPerson.period
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
Short | Period of time that this relationship is considered valid
Control | 0..01
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. RelatedPerson.communication
Definition | A language which may be used to communicate with about the patient's health.
Short | A language which may be used to communicate with about the patient's health
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Control | 0..0*
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. RelatedPerson
2. RelatedPerson.relationship
Binding | The codes SHOULD be taken from AIR Related Person Relationship Code (preferred to `https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code` )
4. RelatedPerson.gender
Control | 0..0
6. RelatedPerson.birthDate
Control | 0..0
8. RelatedPerson.address
Type | Address(Common NZ Address datatype)
10. RelatedPerson.photo
Control | 0..0
12. RelatedPerson.period
Control | 0..0
14. RelatedPerson.communication
Control | 0..0

Guidance on how to interpret the contents of this table can be foundhere

0. RelatedPerson
Definition | 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.
Short | A person that is related to a patient, but who is not a direct target of care
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. RelatedPerson.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. RelatedPerson.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. RelatedPerson.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. RelatedPerson.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. RelatedPerson.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. RelatedPerson.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. RelatedPerson.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. RelatedPerson.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. RelatedPerson.identifier
Definition | Identifier for a person within a particular scope.
Short | A human identifier for this person
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. RelatedPerson.active
Definition | Whether this related person record is in active use.
Short | Whether this related person's record is in active use
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Control | 0..1
Type | boolean
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. RelatedPerson.patient
Definition | The patient this person is related to.
Short | The patient this person is related to
Control | 1..1
Type | Reference(Patient)
Is Modifier | false
Summary | true
Requirements | We need to know which patient this RelatedPerson is related to.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. RelatedPerson.relationship
Definition | The nature of the relationship between a patient and the related person.
Short | The nature of the relationship
Control | 0..*
Binding | The codes SHOULD be taken from AIR Related Person Relationship Code (preferred to `https://nzhts.digital.health.nz/fhir/ValueSet/air-related-person-relationship-code` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. RelatedPerson.name
Definition | A name associated with the person.
Short | A name associated with the person
Control | 0..*
Type | HumanName
Is Modifier | false
Summary | true
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. RelatedPerson.telecom
Definition | A contact detail for the person, e.g. a telephone number or an email address.
Short | A contact detail for the person
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | true
Requirements | People have (primary) ways to contact them in some way such as phone, email.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. RelatedPerson.gender
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Short | male | female | other | unknown
Control | 0..0
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` ) The gender of a person used for administrative purposes.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Needed for identification of the person, in combination with (at least) name and birth date.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. RelatedPerson.birthDate
Definition | The date on which the related person was born.
Short | The date on which the related person was born
Control | 0..0
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. RelatedPerson.address
Definition | Address where the related person can be contacted or visited.
Short | Address where the related person can be contacted or visited
Control | 0..*
Type | Address(Common NZ Address datatype)
Is Modifier | false
Summary | true
Requirements | Need to keep track where the related person can be contacted per postal mail or visited.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. RelatedPerson.photo
Definition | Image of the person.
Short | Image of the person
Control | 0..0
Type | Attachment
Is Modifier | false
Summary | false
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. RelatedPerson.period
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
Short | Period of time that this relationship is considered valid
Control | 0..0
Type | Period
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. RelatedPerson.communication
Definition | A language which may be used to communicate with about the patient's health.
Short | A language which may be used to communicate with about the patient's health
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Control | 0..0
Type | BackboneElement
Is Modifier | false
Summary | false
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)