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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: AIR Patient Profile

This profile derived from NZPatient implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).

Usages:

• Refer to this Profile: AIR CarePlan Profile and AIR Immunization Recommendation
• CapabilityStatements using this Profile: AIR FHIR Server Capability Statement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦2.0.0	HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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()
nz-pat-1	error	Patient	only a single official NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.Slices for extension				Content/Rules for all slices
Patient.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Patient.meta.Slices for extension.extension:ModifiedBy		0..1	string	AIR Modified By User URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
Patient.extension		1..*	Extension	Extension
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Recommendation Id URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.meta.id		0..1	string	Unique id for inter-element referencing
Patient.meta.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Patient.meta.Slices for extension.extension:ModifiedBy		0..1	string	AIR Modified By User URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
Patient.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Patient.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Patient.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Patient.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Patient.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	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.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.Slices for identifier.identifier:NHI.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.telecom	C	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address		0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		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. Additional Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦2.0.0	HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cpt-2	error	Patient.telecom	A system is required if a value is provided.	value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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()
nz-pat-1	error	Patient	only a single official NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦2.0.0	HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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()
nz-pat-1	error	Patient	only a single official NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

Differential View

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
Patient.meta
Patient.meta.Slices for extension				Content/Rules for all slices
Patient.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Patient.meta.Slices for extension.extension:ModifiedBy		0..1	string	AIR Modified By User URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
Patient.extension		1..*	Extension	Extension
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Recommendation Id URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.meta.id		0..1	string	Unique id for inter-element referencing
Patient.meta.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.Slices for extension.extension:ModifiedSourceSystem		0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
Patient.meta.Slices for extension.extension:ModifiedBy		0..1	string	AIR Modified By User URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
Patient.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Patient.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Patient.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
Patient.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Patient.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.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
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
Patient.Slices for extension.extension:ConsumerState		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
Patient.Slices for extension.extension:ConsumerSubStatus		0..1	CodeableConcept	AIR Consumer Sub Status URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status Binding: AIR Consumer Sub Status Code (required)
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	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.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.Slices for identifier.identifier:NHI.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.telecom	C	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address		0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		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. Additional Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦2.0.0	HL7® FHIR® New Zealand Base Implementation Guide v2.0
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cpt-2	error	Patient.telecom	A system is required if a value is provided.	value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	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	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	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()
nz-pat-1	error	Patient	only a single official NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status

Other representations of profile: CSV, Excel, Schematron