Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: DHO Patient Profile

This profile derives from the Patient Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the Dunedin Hospital Outpatients context.

Dunedin Hospital Outpatient profile

Usages:

• Refer to this Profile: DHOCondition, DHO Encounter profile, DHO Encounter profile used to create an Encounter and DHO Encounter profile used to update an Encounter
• Examples for this Profile: Patient/DHO-outpatient-instance-gp-deceased, Patient/DHO-outpatient-instance-gp, Patient/DHO-outpatient-instance-multiple-gp and Patient/DHO-outpatient-instance-np

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, dho-nz-pat-1
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"status"
extension:source		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
url		1..1	uri	"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:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
name	SΣ	1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!SΣ	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name Binding: Name prefix Code (required) This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2, dho-telecom-notification-valid-system, dho-telecom-validation-system
Slices for extension				Content/Rules for all slices
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension				Content/Rules for all slices
extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb	S	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	0..1	Coding	Code defined by a terminology system
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Should be the ISO 3166 code
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0		Extension Slice: Unordered, Open by value:url
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0		Extension Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.address.extension:domicile-code.​value[x]	Base	preferred	Domicile Code	📦3.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍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()
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
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

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: dho-nz-pat-1
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
implicitRules		0..0		A set of rules under which this content was created
language		0..0		Language of the resource content
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	Nz_citizenship	This field indicates New Zealand citizenship status of the patient
Slices for extension				Content/Rules for all slices
extension:source		0..1	Extension	Extension
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
name	S	1..*	HumanName	A name associated with the patient
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	S	1..1	code	usual | temp | nickname | maiden
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given name and other given name(s)
prefix		0..*	string	Parts that come before the name Binding: Name prefix Code (required)
suffix		0..0		Parts that come after the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: dho-telecom-notification-valid-system, dho-telecom-validation-system
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:cp-purpose		0..0		A specific purpose for which this ContactPoint dataType would be used
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
period		0..0		Time period when the contact point was/is in use
birthDate	S	1..1	date	The date of birth for the individual
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0		Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:suburb	S	0..1	Suburb	NZ Suburb
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0		Unique id for inter-element referencing
value[x]
coding	S	0..1	Coding	Code defined by a terminology system
system	S	0..1	uri	Identity of the terminology system
version		0..0		Version of the system - if relevant
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0		If this coding was chosen directly by the user
use	S	1..1	code	home | work | temp | old | billing - purpose of this address
type	S	1..1	code	PHYSICAL | POSTAL
text		0..0		Text representation of the address
line	S	0..2	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district		0..0		District name (aka county)
state	S	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	S	0..1	string	Postal code for area
country	S	0..1	string	Should be the ISO 3166 code
period		0..0		Time period when address was/is in use
photo		0..0		Image of the patient
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..0		Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
use		0..0		usual | official | temp | nickname | anonymous | old | maiden
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
suffix		0..0		Parts that come after the name
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
period		0..0		Time period when the contact point was/is in use
address		0..0		Address for the contact person
gender		0..0		male | female | other | unknown
organization		0..0		Organization that is associated with the contact
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..0		A language which may be used to communicate with the patient about his or her health
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
managingOrganization		0..0		Organization that is the custodian of the patient record
link		0..0		Link to another patient resource that concerns the same actual person
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))

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, dho-nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
extension:source		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
url		1..1	uri	"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:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!SΣ	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name Binding: Name prefix Code (required) This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2, dho-telecom-notification-valid-system, dho-telecom-validation-system
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb	S	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Should be the ISO 3166 code
maritalStatus		0..1	CodeableConcept	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			boolean
multipleBirthInteger			integer
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0		Extension Slice: Unordered, Open by value:url
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0		Extension Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
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.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.extension:domicile-code.​value[x]	Base	preferred	Domicile Code	📦3.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍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()
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
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: 4 elements(16 nested mandatory elements)
Must-Support: 36 elements
Fixed: 1 element
Prohibited: 30 elements

Structures

This structure refers to these other structures:

• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.3.0
• http://hl7.org/fhir/StructureDefinition/iso21090-preferred
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.contained (Closed)

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, dho-nz-pat-1
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"status"
extension:source		0..1	Extension	Extension
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
url		1..1	uri	"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:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
name	SΣ	1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!SΣ	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name Binding: Name prefix Code (required) This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2, dho-telecom-notification-valid-system, dho-telecom-validation-system
Slices for extension				Content/Rules for all slices
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension				Content/Rules for all slices
extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb	S	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	0..1	Coding	Code defined by a terminology system
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Should be the ISO 3166 code
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0		Extension Slice: Unordered, Open by value:url
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0		Extension Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.address.extension:domicile-code.​value[x]	Base	preferred	Domicile Code	📦3.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍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()
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
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()

Differential View

This structure is derived from NzPatient

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: dho-nz-pat-1
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
implicitRules		0..0		A set of rules under which this content was created
language		0..0		Language of the resource content
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	Nz_citizenship	This field indicates New Zealand citizenship status of the patient
Slices for extension				Content/Rules for all slices
extension:source		0..1	Extension	Extension
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
name	S	1..*	HumanName	A name associated with the patient
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	S	1..1	code	usual | temp | nickname | maiden
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given name and other given name(s)
prefix		0..*	string	Parts that come before the name Binding: Name prefix Code (required)
suffix		0..0		Parts that come after the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: dho-telecom-notification-valid-system, dho-telecom-validation-system
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:cp-purpose		0..0		A specific purpose for which this ContactPoint dataType would be used
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
period		0..0		Time period when the contact point was/is in use
birthDate	S	1..1	date	The date of birth for the individual
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0		Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..0		Unique id for inter-element referencing
Slices for extension				Content/Rules for all slices
extension:suburb	S	0..1	Suburb	NZ Suburb
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0		Unique id for inter-element referencing
value[x]
coding	S	0..1	Coding	Code defined by a terminology system
system	S	0..1	uri	Identity of the terminology system
version		0..0		Version of the system - if relevant
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0		If this coding was chosen directly by the user
use	S	1..1	code	home | work | temp | old | billing - purpose of this address
type	S	1..1	code	PHYSICAL | POSTAL
text		0..0		Text representation of the address
line	S	0..2	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district		0..0		District name (aka county)
state	S	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	S	0..1	string	Postal code for area
country	S	0..1	string	Should be the ISO 3166 code
period		0..0		Time period when address was/is in use
photo		0..0		Image of the patient
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..0		Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
use		0..0		usual | official | temp | nickname | anonymous | old | maiden
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
suffix		0..0		Parts that come after the name
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..0		Unique id for inter-element referencing
extension		0..0		Extension
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
period		0..0		Time period when the contact point was/is in use
address		0..0		Address for the contact person
gender		0..0		male | female | other | unknown
organization		0..0		Organization that is associated with the contact
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..0		A language which may be used to communicate with the patient about his or her health
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
managingOrganization		0..0		Organization that is the custodian of the patient record
link		0..0		Link to another patient resource that concerns the same actual person
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5

Constraints

Id	Grade	Path(s)	Description	Expression
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))

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, dho-nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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
Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this
contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
extension:source		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"source"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
url		1..1	uri	"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:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!SΣ	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name Binding: Name prefix Code (required) This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2, dho-telecom-notification-valid-system, dho-telecom-validation-system
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:notification-enabled	S	0..1	boolean	True if notifications can be sent to this email or SMS address URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
extension:validation-status	S	0..1	CodeableConcept	Validation status of this telecom URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation Binding: Allowed Telecom Validation Statuses (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	SΣ	1..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb	S	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Should be the ISO 3166 code
maritalStatus		0..1	CodeableConcept	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			boolean
multipleBirthInteger			integer
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:role		0..*	CodeableConcept	DHO Patient Contact Role URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id Binding: ValueSet for Patient Contact Role (required)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0		Extension Slice: Unordered, Open by value:url
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0		Extension Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
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.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.extension:ethnicity.​value[x]	Base	required	Ethnicity of a person (L4)	📍2.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:status.value[x]	Base	preferred	NZ Citizenship status	📦1.1.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.extension:nzCitizen.​extension:source.value[x]	Base	required	NZ Citizenship Information Source	⏿20230401	nzhts.digital.health.nz
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name.prefix	Base	required	Name prefix Code	⏿20230401	nzhts.digital.health.nz
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.extension:domicile-code.​value[x]	Base	preferred	Domicile Code	📦3.0	HL7® FHIR® New Zealand Base Implementation Guide v3.0
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.contact.relationship	Base	required	PersonalRelationshipRoleType	📍3.0.0	THO v6.5
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍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()
dho-nz-pat-1	error	Patient	only allows certain name name use values	Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') )
dho-telecom-notification-valid-system	warning	Patient.telecom	The notification-enabled extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
dho-telecom-validation-system	warning	Patient.telecom	The validation-status extension should only be present when the telecom system is 'email', 'sms', or 'phone' with use 'mobile'.	extension.where(url = 'https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation').exists() implies (system = 'email' or system = 'sms' or (system = 'phone' and use = 'mobile'))
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: 4 elements(16 nested mandatory elements)
Must-Support: 36 elements
Fixed: 1 element
Prohibited: 30 elements

Structures

This structure refers to these other structures:

• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.3.0
• http://hl7.org/fhir/StructureDefinition/iso21090-preferred
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-notification
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-telecom-validation
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/dho-patient-contact-role-extension-id

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.contained (Closed)