AIR Patient Profile - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide v2.7.0

0..*

NzPatient

Information about an individual or animal receiving health care services
Constraints: nz-pat-1

id

Σ

0..1

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

0..*

extension:ModifiedSourceSystem

Additional content defined by implementations
Slice: Unordered, Open by value:url

0..1

AIR Modified Source System
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system

extension:ModifiedBy

0..1

AIR Modified By User
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by

versionId

Σ

0..1

Version specific identifier

lastUpdated

Σ

0..1

instant

When the resource version last changed

source

Σ

0..1

canonical(StructureDefinition)

Identifies where the resource comes from

profile

Σ

0..*

Profiles this resource claims to conform to

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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".

implicitRules

?!Σ

0..1

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

1..*

Extension
Slice: Unordered, Open by value:url

extension:ethnicity

0..*

NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)

extension:nzCitizen

0..1

(Complex)

Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship

extension:dhb

0..1

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

extension:domicile-code

0..1

NZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)

extension:pho

0..1

Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

extension:sex-at-birth

0..1

Sex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)

extension:iwi

0..*

Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)

extension:NIROptOff

0..1

AIR Consumer NIR Opt Off
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off

extension:ConsumerState

1..1

extension:ConsumerSubStatus

AIR Consumer State
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state

0..1

AIR Consumer Sub Status
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status
Binding: AIR Consumer Sub Status Code (required)

?!

0..*

Extensions that cannot be ignored

Slices for identifier

Σ

0..*

An identifier for this patient
Slice: Unordered, Open by value:system

identifier:NHI

Σ

0..*

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

system

Σ

1..1

The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id

value

Σ

0..1

The value that is unique
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

Σ

0..*

A name associated with the patient

0..*

NzContactPoint

Details of a Technology mediated contact point (phone, fax, email, etc.)
Constraints: cpt-2

Σ

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

birthDate

Σ

0..1

The date of birth for the individual

deceased[x]

?!Σ

0..1

Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

0..*

An address expressed using postal conventions (as opposed to GPS or other location definition formats)

maritalStatus

0..1

Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

multipleBirth[x]

0..1

Whether patient is part of a multiple birth

multipleBirthBoolean

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

ContactPoint

A contact detail for the person

address

0..1

Address

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

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

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

other

Σ

1..1

Reference(Patient | RelatedPerson)

The other patient or related person resource that the link refers to

Σ

1..1

Documentation for this format

replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

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:

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
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
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
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
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:NIROptOff		0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
extension:ConsumerState		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
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)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: Valid use values for NHI (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Patient	0..*	NzPatient	Information about an individual or animal receiving health care services
meta
Slices for extension			Content/Rules for all slices
extension:ModifiedSourceSystem	0..1	string	AIR Modified Source System URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
extension:ModifiedBy	0..1	string	AIR Modified By User URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
extension	1..*	Extension	Extension
Slices for extension			Content/Rules for all slices
extension:NIROptOff	0..1	date	AIR Consumer NIR Opt Off URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off
extension:ConsumerState	1..1	string	AIR Recommendation Id URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
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

Description & Constraints Filter: Filters

Patient

0..*

NzPatient

Information about an individual or animal receiving health care services
Constraints: nz-pat-1

id

Σ

0..1

Logical id of this artifact

Meta

Metadata about the resource

id

0..1

Unique id for inter-element referencing

0..*

extension:ModifiedSourceSystem

Additional content defined by implementations
Slice: Unordered, Open by value:url

0..1

AIR Modified Source System
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system

extension:ModifiedBy

0..1

AIR Modified By User
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by

versionId

Σ

0..1

Version specific identifier

lastUpdated

Σ

0..1

instant

When the resource version last changed

source

Σ

0..1

canonical(StructureDefinition)

Identifies where the resource comes from

profile

Σ

0..*

Profiles this resource claims to conform to

security

Σ

0..*

Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.

tag

Σ

0..*

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".

implicitRules

?!Σ

0..1

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

text

0..1

Narrative

Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements

contained

0..*

Resource

Contained, inline Resources

1..*

Extension
Slice: Unordered, Open by value:url

extension:ethnicity

0..*

NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)

extension:nzCitizen

0..1

(Complex)

Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship

extension:dhb

0..1

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

extension:domicile-code

0..1

NZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)

extension:pho

0..1

Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

extension:sex-at-birth

0..1

Sex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)

extension:iwi

0..*

Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)

extension:NIROptOff

0..1

AIR Consumer NIR Opt Off
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off

extension:ConsumerState

1..1

extension:ConsumerSubStatus

AIR Consumer State
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state

0..1

AIR Consumer Sub Status
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status
Binding: AIR Consumer Sub Status Code (required)

?!

0..*

Extensions that cannot be ignored

Slices for identifier

Σ

0..*

An identifier for this patient
Slice: Unordered, Open by value:system

identifier:NHI

Σ

0..*

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)

Σ

0..1

Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

system

Σ

1..1

The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id

value

Σ

0..1

The value that is unique
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

Σ

0..*

A name associated with the patient

0..*

NzContactPoint

Details of a Technology mediated contact point (phone, fax, email, etc.)
Constraints: cpt-2

Σ

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

birthDate

Σ

0..1

The date of birth for the individual

deceased[x]

?!Σ

0..1

Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

0..*

An address expressed using postal conventions (as opposed to GPS or other location definition formats)

maritalStatus

0..1

Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

multipleBirth[x]

0..1

Whether patient is part of a multiple birth

multipleBirthBoolean

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

ContactPoint

A contact detail for the person

address

0..1

Address

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

1..1

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

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

other

Σ

1..1

Reference(Patient | RelatedPerson)

The other patient or related person resource that the link refers to

Σ

1..1