Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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, DHO Encounter profile used to update an Encounter and DHO Service Request Profile
• 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
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient.Slices for extension.extension:ethnicity.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.url		1..1	uri	"status"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.url		1..1	uri	"source"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:nzCitizen.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	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
Patient.telecom	S This element must be supported. C	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
Patient.telecom.Slices for extension				Content/Rules for all slices
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient.address.Slices for extension.extension:domicile-code.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Patient.address.Slices for extension.extension:domicile-code.value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported. Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.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
Patient.address.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	S This element must be supported. Σ This element is included in summaries.	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.contact	S This element must be supported. C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.name.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported. Σ This element is included in summaries.	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
Patient.contact.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.contact.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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
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'))

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
Patient.meta
Patient.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Patient.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Patient.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Patient.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Patient.implicitRules		0..0		A set of rules under which this content was created
Patient.language		0..0		Language of the resource content
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	Nz_citizenship	This field indicates New Zealand citizenship status of the patient
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.name	S This element must be supported.	1..*	HumanName	A name associated with the patient
Patient.name.id		0..0		Unique id for inter-element referencing
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	S This element must be supported.	1..1	code	usual | temp | nickname | maiden
Patient.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported.	0..*	string	Given name and other given name(s)
Patient.name.prefix		0..*	string	Parts that come before the name Binding: Name prefix Code (required)
Patient.name.suffix		0..0		Parts that come after the name
Patient.telecom	S This element must be supported. C	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: dho-telecom-notification-valid-system, dho-telecom-validation-system
Patient.telecom.id		0..0		Unique id for inter-element referencing
Patient.telecom.Slices for extension				Content/Rules for all slices
Patient.telecom.Slices for extension.extension:cp-purpose		0..0		A specific purpose for which this ContactPoint dataType would be used
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
Patient.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.telecom.use	S This element must be supported.	1..1	code	home | work | temp | old | mobile - purpose of this contact point
Patient.telecom.period		0..0		Time period when the contact point was/is in use
Patient.birthDate	S This element must be supported.	1..1	date	The date of birth for the individual
Patient.Slices for deceased[x]				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean		0..0		Indicates if the individual is deceased or not
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.id		0..0		Unique id for inter-element referencing
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	Suburb	NZ Suburb
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	Domicile_code	NZ Domicile Code
Patient.address.Slices for extension.extension:domicile-code.id		0..0		Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x]
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.version		0..0		Version of the system - if relevant
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.userSelected		0..0		If this coding was chosen directly by the user
Patient.address.use	S This element must be supported.	1..1	code	home | work | temp | old | billing - purpose of this address
Patient.address.type	S This element must be supported.	1..1	code	PHYSICAL | POSTAL
Patient.address.text		0..0		Text representation of the address
Patient.address.line	S This element must be supported.	0..2	string	Street name, number, direction & P.O. Box etc.
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc.
Patient.address.district		0..0		District name (aka county)
Patient.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported.	0..1	string	Postal code for area
Patient.address.country	S This element must be supported.	0..1	string	Should be the ISO 3166 code
Patient.address.period		0..0		Time period when address was/is in use
Patient.photo		0..0		Image of the patient
Patient.contact	S This element must be supported.	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
Patient.contact.id		0..0		Unique id for inter-element referencing
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.id		0..0		Unique id for inter-element referencing
Patient.contact.name.extension		0..0		Extension
Patient.contact.name.use		0..0		usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.text	S This element must be supported.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported.	0..*	string	Given names (not always 'first'). Includes middle names
Patient.contact.name.prefix	S This element must be supported.	0..1	string	Parts that come before the name
Patient.contact.name.suffix		0..0		Parts that come after the name
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.id		0..0		Unique id for inter-element referencing
Patient.contact.telecom.extension		0..0		Extension
Patient.contact.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
Patient.contact.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.contact.telecom.use	S This element must be supported.	1..1	code	home | work | temp | old | mobile - purpose of this contact point
Patient.contact.telecom.period		0..0		Time period when the contact point was/is in use
Patient.contact.address		0..0		Address for the contact person
Patient.contact.gender		0..0		male | female | other | unknown
Patient.contact.organization		0..0		Organization that is associated with the contact
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..0		A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
Patient.managingOrganization		0..0		Organization that is the custodian of the patient record
Patient.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
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.meta.id		0..1	string	Unique id for inter-element referencing
Patient.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Patient.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Patient.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Patient.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Patient.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Patient.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Patient.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Patient.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Patient.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Patient.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient.Slices for extension.extension:ethnicity.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:ethnicity.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:nzCitizen.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.url		1..1	uri	"status"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.url		1..1	uri	"source"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:nzCitizen.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.Slices for identifier.identifier:NHI.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.name.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	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
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	S This element must be supported. C	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
Patient.telecom.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.gender.id		0..1	string	xml:id (or equivalent in JSON)
Patient.gender.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.gender.Slices for extension.extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
Patient.gender.value		0..1	string	Primitive value for code
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient.address.Slices for extension.extension:domicile-code.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Patient.address.Slices for extension.extension:domicile-code.value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:domicile-code.value[x].id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported. Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Patient.address.Slices for extension.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
Patient.address.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	S This element must be supported. Σ This element is included in summaries.	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.contact	S This element must be supported. C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.name.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported. Σ This element is included in summaries.	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
Patient.contact.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.contact.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.contact.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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
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'))

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
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient.Slices for extension.extension:ethnicity.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.url		1..1	uri	"status"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.url		1..1	uri	"source"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:nzCitizen.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	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
Patient.telecom	S This element must be supported. C	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
Patient.telecom.Slices for extension				Content/Rules for all slices
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient.address.Slices for extension.extension:domicile-code.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Patient.address.Slices for extension.extension:domicile-code.value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported. Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.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
Patient.address.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	S This element must be supported. Σ This element is included in summaries.	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.contact	S This element must be supported. C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.name.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported. Σ This element is included in summaries.	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
Patient.contact.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.contact.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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
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'))

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
Patient.meta
Patient.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Patient.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Patient.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Patient.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Patient.implicitRules		0..0		A set of rules under which this content was created
Patient.language		0..0		Language of the resource content
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	Nz_citizenship	This field indicates New Zealand citizenship status of the patient
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.name	S This element must be supported.	1..*	HumanName	A name associated with the patient
Patient.name.id		0..0		Unique id for inter-element referencing
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	S This element must be supported.	1..1	code	usual | temp | nickname | maiden
Patient.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported.	0..*	string	Given name and other given name(s)
Patient.name.prefix		0..*	string	Parts that come before the name Binding: Name prefix Code (required)
Patient.name.suffix		0..0		Parts that come after the name
Patient.telecom	S This element must be supported. C	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: dho-telecom-notification-valid-system, dho-telecom-validation-system
Patient.telecom.id		0..0		Unique id for inter-element referencing
Patient.telecom.Slices for extension				Content/Rules for all slices
Patient.telecom.Slices for extension.extension:cp-purpose		0..0		A specific purpose for which this ContactPoint dataType would be used
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
Patient.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.telecom.use	S This element must be supported.	1..1	code	home | work | temp | old | mobile - purpose of this contact point
Patient.telecom.period		0..0		Time period when the contact point was/is in use
Patient.birthDate	S This element must be supported.	1..1	date	The date of birth for the individual
Patient.Slices for deceased[x]				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean		0..0		Indicates if the individual is deceased or not
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.id		0..0		Unique id for inter-element referencing
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	Suburb	NZ Suburb
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	Domicile_code	NZ Domicile Code
Patient.address.Slices for extension.extension:domicile-code.id		0..0		Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x]
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.version		0..0		Version of the system - if relevant
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.userSelected		0..0		If this coding was chosen directly by the user
Patient.address.use	S This element must be supported.	1..1	code	home | work | temp | old | billing - purpose of this address
Patient.address.type	S This element must be supported.	1..1	code	PHYSICAL | POSTAL
Patient.address.text		0..0		Text representation of the address
Patient.address.line	S This element must be supported.	0..2	string	Street name, number, direction & P.O. Box etc.
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc.
Patient.address.district		0..0		District name (aka county)
Patient.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported.	0..1	string	Postal code for area
Patient.address.country	S This element must be supported.	0..1	string	Should be the ISO 3166 code
Patient.address.period		0..0		Time period when address was/is in use
Patient.photo		0..0		Image of the patient
Patient.contact	S This element must be supported.	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
Patient.contact.id		0..0		Unique id for inter-element referencing
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.id		0..0		Unique id for inter-element referencing
Patient.contact.name.extension		0..0		Extension
Patient.contact.name.use		0..0		usual | official | temp | nickname | anonymous | old | maiden
Patient.contact.name.text	S This element must be supported.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported.	0..*	string	Given names (not always 'first'). Includes middle names
Patient.contact.name.prefix	S This element must be supported.	0..1	string	Parts that come before the name
Patient.contact.name.suffix		0..0		Parts that come after the name
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.id		0..0		Unique id for inter-element referencing
Patient.contact.telecom.extension		0..0		Extension
Patient.contact.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
Patient.contact.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
Patient.contact.telecom.use	S This element must be supported.	1..1	code	home | work | temp | old | mobile - purpose of this contact point
Patient.contact.telecom.period		0..0		Time period when the contact point was/is in use
Patient.contact.address		0..0		Address for the contact person
Patient.contact.gender		0..0		male | female | other | unknown
Patient.contact.organization		0..0		Organization that is associated with the contact
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..0		A language which may be used to communicate with the patient about his or her health
Patient.generalPractitioner		0..*	Reference(PractitionerRole | Practitioner resource for use in NZ | Organization)	Reference for the Patient's enrolled general Practitioner
Patient.managingOrganization		0..0		Organization that is the custodian of the patient record
Patient.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
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.meta.id		0..1	string	Unique id for inter-element referencing
Patient.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Patient.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Patient.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Patient.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Patient.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Patient.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Patient.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Patient.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Patient.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Patient.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Patient.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.Slices for contained		0..*	Resource	Contained, inline Resources Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for contained.contained:GP		0..*	PractitionerRole	Contained resource for the Patient's enrolled general Practitioner
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient.Slices for extension.extension:ethnicity.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:ethnicity.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Patient.Slices for extension.extension:ethnicity.value[x]		1..1	CodeableConcept	Value of extension Binding: Ethnicity (2.1.0) (required)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	This field indicates New Zealand citizenship status of the patient URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:nzCitizen.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.url		1..1	uri	"status"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:status.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source		0..1	Extension	Extension
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.url		1..1	uri	"source"
Patient.Slices for extension.extension:nzCitizen.Slices for extension.extension:source.value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship Information Source (required)
Patient.Slices for extension.extension:nzCitizen.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
Patient.Slices for identifier.identifier:NHI	Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Patient.Slices for identifier.identifier:NHI.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.name.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.Slices for extension.extension:preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | temp | nickname | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given name and other given name(s) This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	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
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	S This element must be supported. C	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
Patient.telecom.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.Slices for extension.extension:notification-enabled	S This element must be supported.	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
Patient.telecom.Slices for extension.extension:validation-status	S This element must be supported.	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)
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.gender.id		0..1	string	xml:id (or equivalent in JSON)
Patient.gender.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.gender.Slices for extension.extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
Patient.gender.value		0..1	string	Primitive value for code
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	S This element must be supported.	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code	S This element must be supported.	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient.address.Slices for extension.extension:domicile-code.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Patient.address.Slices for extension.extension:domicile-code.value[x]		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:domicile-code.value[x].id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.value[x].coding	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.code	S This element must be supported. Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].coding.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Patient.address.Slices for extension.extension:domicile-code.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Patient.address.Slices for extension.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
Patient.address.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	S This element must be supported. Σ This element is included in summaries.	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.contact	S This element must be supported. C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.Slices for extension.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)
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PersonalRelationshipRoleType (3.0.0) (required)
Patient.contact.name	S This element must be supported.	1..1	HumanName	A name associated with the contact person
Patient.contact.name.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.name.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.contact.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Patient.contact.name.given	S This element must be supported. Σ This element is included in summaries.	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
Patient.contact.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.contact.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.contact.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the person
Patient.contact.telecom.extension		0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.contact.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.contact.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.contact.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.contact.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.contact.period	S This element must be supported.	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
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
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'))

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)