Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: NZCentralRegionPatient

Patient resource for Te Whatu Ora, Central Region

Usage:

• Derived from this Resource Profile: NZCentralRegionPatientAdditionalBinding
• Examples for this Resource Profile: Patient/Address-Suburb, Patient/Contact, Patient/Ethnicity-MultipleCodings-Slicing, Patient/GeneralPractitioner... Show 7 more, Patient/HL7Message, Patient/LanguageSingle, Patient/MaritalStatus-CommonLaw, Patient/MaritalStatus-Single, Patient/Religion-NoAnswer-Slicing, Patient/Religion-Presbyterian-Slicing and Patient/Residency-Slicing

Formal Views of Profile Content

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

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

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
meta
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	base64Binary	Value of extension
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
Slices for extension				Content/Rules for all slices
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
Slices for extension				Content/Rules for all slices
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
Slices for extension				Content/Rules for all slices
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
Slices for extension				Content/Rules for all slices
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
Slices for extension				Content/Rules for all slices
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
Slices for extension				Content/Rules for all slices
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
extension:nzCitizen	S	0..1	Nz_citizenship	NZ Citizenship
id		0..0
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
id		0..0
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
id		0..0
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
Slices for extension				Content/Rules for all slices
extension:source		0..0
url		1..1	uri	identifies the meaning of the extension
extension:dhb	S	0..1	Dhb	District Health Board linked to a NZ Healthcare Service, Location or Patient
id		0..0
url		1..1	uri	identifies the meaning of the extension
value[x]
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
text		0..0
extension:pho		0..0
extension:sex-at-birth		0..0
extension:iwi		0..0
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
id		0..0
value[x]
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:level2		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:level4		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
id		0..0
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
id		0..0
url		1..1	uri	identifies the meaning of the extension
value[x]
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:nzBase		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:rawSource		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
Slices for extension				Content/Rules for all slices
extension:source		0..0
url		1..1	uri	identifies the meaning of the extension
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
url		1..1	uri	identifies the meaning of the extension
value[x]
id		0..0
Slices for coding	S	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:origFhir		0..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:rawSource		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	boolean	Value of extension
identifier	S	1..*	Identifier	An identifier for this patient
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
coding	S	0..*	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
Slices for identifier				Content/Rules for all slices
identifier:NHI		0..*	Identifier	An identifier for this patient
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
name	S	1..*	HumanName	A name associated with the patient
id		0..0
extension		0..0
use	S	1..1	code	one of: official / nickname
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix		0..0
telecom	S	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.)
id		0..0
extension		0..0
Slices for extension				Content/Rules for all slices
extension:cp-purpose		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
rank		0..0
period		0..0
gender	S	1..1	code	male | female | other | unknown
birthDate	S	1..1	date	The date of birth for the individual
Slices for deceased[x]	S	1..1	boolean, dateTime	deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..0
Slices for extension				Content/Rules for all slices
extension:nz-geocode		0..0
extension:suburb	S	0..1	Suburb	NZ Suburb
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	NZSuburb
extension:building-name		0..0
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
text		0..0
use	S	1..1	code	home | work | temp | old | billing - purpose of this address
type	S	1..1	code	PHYSICAL | POSTAL
text		0..0
line	S	0..2	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district		0..0
state	S	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	S	0..1	string	Postal code for area
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period		0..0
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
id		0..0
extension		0..0
coding	S	1..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
multipleBirth[x]		0..0
photo		0..0
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..0
extension		0..0
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship
id		0..0
extension		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
name	S	1..1	HumanName	A name associated with the contact person
id		0..0
extension		0..0
use		0..0
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
suffix		0..0
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..0
extension		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
rank		0..0
address		0..0
gender		0..0
organization		0..0
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..0
extension		0..0
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
id		0..0
extension		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	0..1	uri	Identity of the terminology system
version		0..0
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient")
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
managingOrganization		0..0
link	S	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..0
extension		0..0
other	S	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
reference		0..0
type	S	0..1	uri	Patient Required Pattern: Patient
identifier	S	1..1	Identifier	Business-level identifier for the Patient being replaced
display		0..0
type	S	1..1	code	replaced-by | replaces
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension				Content/Rules for all slices
ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: Ethnicity of a person (preferred)
nzCitizen	S	0..1	(Complex)	NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
dhb	S	0..1	(Complex)	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/dhb"
value[x]		0..1	CodeableConcept	NZ District Health Boards Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato"}]}
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Ethnicity Value Set (required)
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level2	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level4	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	SΣ	1..1	string	Representation defined by the system
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined NZ Residency Value Set (required)
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:nzBase	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-residency"
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/religion"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Religion Value Set (required)
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:origFhir	Σ	0..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]		1..1	boolean	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
coding	SΣ	0..*	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
extension		0..0
use	?!SΣ	1..1	code	one of: official / nickname Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided.
Slices for extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for deceased[x]	?!SΣ	1..1		deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension				Content/Rules for all slices
suburb	S	0..1	(Complex)	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x]		0..1	string	NZSuburb Example Rototuna: Rototuna
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
link	?!SΣ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	SΣ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	SΣ	0..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Business-level identifier for the Patient being replaced
type	SΣ	1..1	code	replaced-by | replaces Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:ethnicity.value[x]:valueCodeableConcept	preferred	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept	preferred	CitizenshipStatus https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:dhb.value[x]	extensible	DHB https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
Patient.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.extension:nzcrEthnicity.value[x]	required	NZCentralRegionCombinedEthnicityValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x]	required	NZCentralRegionCombinedResidencyValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency from this IG
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrReligion.value[x]	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.generalPractitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.generalPractitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.generalPractitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.link.other.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: Ethnicity of a person (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
nzCitizen	S	0..1	(Complex)	NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
dhb	S	0..1	(Complex)	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/dhb"
value[x]		0..1	CodeableConcept	NZ District Health Boards Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato"}]}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Ethnicity Value Set (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level2	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level4	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	SΣ	1..1	string	Representation defined by the system
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined NZ Residency Value Set (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:nzBase	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-residency"
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/religion"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Religion Value Set (required)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:origFhir	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]		1..1	boolean	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
extension		0..0
use	?!SΣ	1..1	code	one of: official / nickname Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided.
Slices for extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for deceased[x]	?!SΣ	1..1		deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
suburb	S	0..1	(Complex)	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x]		0..1	string	NZSuburb Example Rototuna: Rototuna
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	Σ	0..1	Period	Time period when the contact point was/is in use
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
link	?!SΣ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	SΣ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	SΣ	0..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Business-level identifier for the Patient being replaced
type	SΣ	1..1	code	replaced-by | replaces Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.extension:ethnicity.value[x]:valueCodeableConcept	preferred	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept	preferred	CitizenshipStatus https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:dhb.value[x]	extensible	DHB https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
Patient.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.extension:nzcrEthnicity.value[x]	required	NZCentralRegionCombinedEthnicityValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x]	required	NZCentralRegionCombinedResidencyValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency from this IG
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrResidency.extension:source.value[x]	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:nzcrReligion.value[x]	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.generalPractitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.generalPractitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.generalPractitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.link.other.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 17 elements(81 nested mandatory elements)
Must-Support: 141 elements
Fixed: 5 elements
Prohibited: 127 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/ns/central-region/hl7v2-message
• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/nz-ethnicity
• https://standards.digital.health.nz/ns/central-region/nz-residency
• https://standards.digital.health.nz/ns/central-region/religion
• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.extension.value[x].coding
• The element 1 is sliced based on the value of Patient.extension.extension.value[x].coding
• The element 1 is sliced based on the value of Patient.deceased[x]

Differential View

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
meta
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	base64Binary	Value of extension
Slices for extension				Content/Rules for all slices
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
Slices for extension				Content/Rules for all slices
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
Slices for extension				Content/Rules for all slices
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
Slices for extension				Content/Rules for all slices
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
Slices for extension				Content/Rules for all slices
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
Slices for extension				Content/Rules for all slices
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
Slices for extension				Content/Rules for all slices
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	Nz_ethnicity	NZ Ethnicity
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
extension:nzCitizen	S	0..1	Nz_citizenship	NZ Citizenship
id		0..0
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
id		0..0
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
id		0..0
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
Slices for extension				Content/Rules for all slices
extension:source		0..0
url		1..1	uri	identifies the meaning of the extension
extension:dhb	S	0..1	Dhb	District Health Board linked to a NZ Healthcare Service, Location or Patient
id		0..0
url		1..1	uri	identifies the meaning of the extension
value[x]
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0
url		1..1	uri	identifies the meaning of the extension
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
text		0..0
extension:pho		0..0
extension:sex-at-birth		0..0
extension:iwi		0..0
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
id		0..0
value[x]
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:level2		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:level4		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
id		0..0
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
id		0..0
url		1..1	uri	identifies the meaning of the extension
value[x]
Slices for coding	S	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:nzBase		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:rawSource		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
Slices for extension				Content/Rules for all slices
extension:source		0..0
url		1..1	uri	identifies the meaning of the extension
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
url		1..1	uri	identifies the meaning of the extension
value[x]
id		0..0
Slices for coding	S	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:origFhir		0..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
Slices for coding				Content/Rules for all slices
coding:rawSource		1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
url		1..1	uri	identifies the meaning of the extension
value[x]		1..1	boolean	Value of extension
identifier	S	1..*	Identifier	An identifier for this patient
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
coding	S	0..*	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
Slices for identifier				Content/Rules for all slices
identifier:NHI		0..*	Identifier	An identifier for this patient
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
assigner		0..0
name	S	1..*	HumanName	A name associated with the patient
id		0..0
extension		0..0
use	S	1..1	code	one of: official / nickname
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix		0..0
telecom	S	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.)
id		0..0
extension		0..0
Slices for extension				Content/Rules for all slices
extension:cp-purpose		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
rank		0..0
period		0..0
gender	S	1..1	code	male | female | other | unknown
birthDate	S	1..1	date	The date of birth for the individual
Slices for deceased[x]	S	1..1	boolean, dateTime	deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime		0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean		0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..0
Slices for extension				Content/Rules for all slices
extension:nz-geocode		0..0
extension:suburb	S	0..1	Suburb	NZ Suburb
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1	string	NZSuburb
extension:building-name		0..0
extension:domicile-code	S	0..1	Domicile_code	NZ Domicile Code
id		0..0
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension
coding	S	1..1	Coding	Code defined by a terminology system
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
text		0..0
use	S	1..1	code	home | work | temp | old | billing - purpose of this address
type	S	1..1	code	PHYSICAL | POSTAL
text		0..0
line	S	0..2	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district		0..0
state	S	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	S	0..1	string	Postal code for area
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period		0..0
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
id		0..0
extension		0..0
coding	S	1..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
multipleBirth[x]		0..0
photo		0..0
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
id		0..0
extension		0..0
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship
id		0..0
extension		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system
display	S	1..1	string	Representation defined by the system
userSelected		0..0
text		0..0
name	S	1..1	HumanName	A name associated with the contact person
id		0..0
extension		0..0
use		0..0
text	S	1..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..1	string	Parts that come before the name
suffix		0..0
telecom	S	0..*	ContactPoint	A contact detail for the person
id		0..0
extension		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
rank		0..0
address		0..0
gender		0..0
organization		0..0
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..0
extension		0..0
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
id		0..0
extension		0..0
coding		0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	0..1	uri	Identity of the terminology system
version		0..0
code	S	0..1	code	Symbol in syntax defined by the system
display	S	0..1	string	Representation defined by the system
userSelected		0..0
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
id		0..0
extension		0..0
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
type	S	1..1	uri	Type the reference refers to (e.g. "Patient")
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
id		0..0
extension		0..0
use	S	1..1	code	usual | official | temp | secondary | old (If known)
type	S	1..1	CodeableConcept	Description of identifier
id		0..0
extension		0..0
coding	S	0..*	Coding	Code defined by a terminology system
id		0..0
extension		0..0
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0
code	S	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	S	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
userSelected		0..0
text		0..0
system	S	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value		0..1	string	The value that is unique
period		0..0
assigner		0..0
display	S	0..1	string	Text alternative for the resource
managingOrganization		0..0
link	S	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..0
extension		0..0
other	S	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
reference		0..0
type	S	0..1	uri	Patient Required Pattern: Patient
identifier	S	1..1	Identifier	Business-level identifier for the Patient being replaced
display		0..0
type	S	1..1	code	replaced-by | replaces
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
meta	Σ	0..1	Meta	Metadata about the resource
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
Slices for extension				Content/Rules for all slices
ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: Ethnicity of a person (preferred)
nzCitizen	S	0..1	(Complex)	NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
dhb	S	0..1	(Complex)	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/dhb"
value[x]		0..1	CodeableConcept	NZ District Health Boards Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato"}]}
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Ethnicity Value Set (required)
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level2	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level4	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	SΣ	1..1	string	Representation defined by the system
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined NZ Residency Value Set (required)
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:nzBase	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-residency"
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/religion"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Religion Value Set (required)
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:origFhir	Σ	0..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]		1..1	boolean	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
coding	SΣ	0..*	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
extension		0..0
use	?!SΣ	1..1	code	one of: official / nickname Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided.
Slices for extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for deceased[x]	?!SΣ	1..1		deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension				Content/Rules for all slices
suburb	S	0..1	(Complex)	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x]		0..1	string	NZSuburb Example Rototuna: Rototuna
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
coding	SΣ	1..1	Coding	Code defined by a terminology system
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
link	?!SΣ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	SΣ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	SΣ	0..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Business-level identifier for the Patient being replaced
type	SΣ	1..1	code	replaced-by | replaces Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:ethnicity.value[x]:valueCodeableConcept	preferred	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept	preferred	CitizenshipStatus https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:dhb.value[x]	extensible	DHB https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
Patient.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.extension:nzcrEthnicity.value[x]	required	NZCentralRegionCombinedEthnicityValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x]	required	NZCentralRegionCombinedResidencyValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency from this IG
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrReligion.value[x]	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.generalPractitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.generalPractitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.generalPractitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.link.other.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
hl7v2Message	S	1..1	(Complex)	HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/hl7v2-message"
value[x]		0..1	base64Binary	Value of extension
process-timestamp	S	0..1	dateTime	Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
source-event-trigger	S	0..1	CodeableConcept	Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required)
source-record-type	S	0..1	CodeableConcept	Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required)
source-record-id	S	0..1	string	Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
source-data-mode-version	S	0..1	string	Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
process-client-id	S	0..1	string	Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
l4h-template-version	S	0..1	string	L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ethnicity		0..*	(Complex)	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity"
Slices for value[x]		1..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Value of extension Binding: Ethnicity of a person (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
nzCitizen	S	0..1	(Complex)	NZ Citizenship URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status	S	1..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: NZ Citizenship status (preferred)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
dhb	S	0..1	(Complex)	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/dhb"
value[x]		0..1	CodeableConcept	NZ District Health Boards Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato"}]}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
nzcrEthnicity	S	0..3	(Complex)	NZ Ethnicity (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-ethnicity
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-ethnicity"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Ethnicity Value Set (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level2	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-2-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Ethnicity Level 2 Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:level4	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/ethnic-group-level-4-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: Ethnicity of a person (required)
display	SΣ	1..1	string	Representation defined by the system
nzcrResidency	S	0..1	(Complex)	NZ Residency (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/nz-residency
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for extension				Content/Rules for all slices
extension:status		0..1	Extension	Extension
extension		0..0
url		1..1	uri	"status"
value[x]		0..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined NZ Residency Value Set (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	2..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:nzBase	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: https://standards.digital.health.nz/ns/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Residency status (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/nz-residency-code
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - NZ Residency Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for extension				Content/Rules for all slices
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/nz-residency"
nzcrReligion	S	0..1	(Complex)	Religious Affiliation (Central Region Edition) URL: https://standards.digital.health.nz/ns/central-region/religion
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://standards.digital.health.nz/ns/central-region/religion"
value[x]		1..1	CodeableConcept	Value of extension Binding: NZ Central Region - Combined Religion Value Set (required)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:origFhir	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ReligiousAffiliation
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: ReligiousAffiliation (required)
display	SΣ	1..1	string	Representation defined by the system
Slices for coding				Content/Rules for all slices
coding:rawSource	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://standards.digital.health.nz/ns/central-region/patient-religion
code	SΣ	1..1	code	Symbol in syntax defined by the system Binding: NZ Central Region - Combined Religion Value Set (required)
display	SΣ	1..1	string	Representation defined by the system
interpreterRequired	S	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]		1..1	boolean	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	SΣ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	SΣ	1..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
extension		0..0
use	?!SΣ	1..1	code	one of: official / nickname Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SC	0..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided.
Slices for extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
Slices for deceased[x]	?!SΣ	1..1		deceasedBoolean = true if patient is deceased and deceased date/time is unknown, deceasedDateTime if known Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not
address	S	0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
suburb	S	0..1	(Complex)	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/suburb"
value[x]		0..1	string	NZSuburb Example Rototuna: Rototuna
domicile-code	S	0..1	(Complex)	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Slices for value[x]				Content/Rules for all slices
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: Domicile Code (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	1..1	code	PHYSICAL | POSTAL Binding: AddressType (required): The type of an address (physical / postal). Example General: both
line	SΣ	0..2	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: NZ Central Region - Marital Status Value Set (required)
extension		0..0
coding	SΣ	1..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
contact	SC	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship	S	1..1	CodeableConcept	One each for * http://terminology.hl7.org/CodeSystem/v2-0131 AND * https://standards.digital.health.nz/ns/central-region/contact-relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	1..1	string	Representation defined by the system
name	S	1..1	HumanName	A name associated with the contact person
extension		0..0
text	SΣ	1..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	A contact detail for the person
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
period	Σ	0..1	Period	Time period when the contact point was/is in use
period	S	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	0..1	uri	Identity of the terminology system
code	SΣ	0..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
preferred	S	0..1	boolean	Language preference indicator
generalPractitioner	S	0..1	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
extension		0..0
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
extension		0..0
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	1..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.
extension		0..0
coding	SΣ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	SΣ	1..1	code	Symbol in syntax defined by the system Required Pattern: LR
display	SΣ	1..1	string	Representation defined by the system Required Pattern: Local Registry ID
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id
value	Σ	0..1	string	The value that is unique Example General: 123456
display	SΣ	0..1	string	Text alternative for the resource
link	?!SΣ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	SΣ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
type	SΣ	0..1	uri	Patient Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	SΣ	1..1	Identifier	Business-level identifier for the Patient being replaced
type	SΣ	1..1	code	replaced-by | replaces Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.extension:ethnicity.value[x]:valueCodeableConcept	preferred	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept	preferred	CitizenshipStatus https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:dhb.value[x]	extensible	DHB https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
Patient.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.extension:nzcrEthnicity.value[x]	required	NZCentralRegionCombinedEthnicityValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level2.code	required	NZCentralRegionEthnicityLevel2ValueSet (a valid code from NZ Central Region - Ethnicity Level 2 Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 from this IG
Patient.extension:nzcrEthnicity.value[x].coding:level4.code	required	Ethnicity https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Patient.extension:nzcrResidency.extension:status.value[x]	required	NZCentralRegionCombinedResidencyValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency from this IG
Patient.extension:nzcrResidency.extension:status.value[x].coding:nzBase.code	required	NZResidency https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
Patient.extension:nzcrResidency.extension:status.value[x].coding:rawSource.code	required	NZCentralRegionResidencyValueSet (a valid code from NZ Central Region - NZ Residency Code System) https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency from this IG
Patient.extension:nzcrResidency.extension:source.value[x]	preferred	InformationSource https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Patient.extension:nzcrReligion.value[x]	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.extension:nzcrReligion.value[x].coding:origFhir.code	required	ReligiousAffiliation http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation
Patient.extension:nzcrReligion.value[x].coding:rawSource.code	required	NZCentralRegionCombinedReligionValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion from this IG
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.extension:domicile-code.value[x]:valueCodeableConcept	preferred	DomicileCode https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	required	NZCentralRegionMaritalStatusValueSet https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status from this IG
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding NZ Central Region - Raw Language Value Value Set Required http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.generalPractitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.generalPractitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.generalPractitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.link.other.type	extensible	Pattern: Patient http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 17 elements(81 nested mandatory elements)
Must-Support: 141 elements
Fixed: 5 elements
Prohibited: 127 elements

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/ns/central-region/hl7v2-message
• http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp
• http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-type
• http://ibm.com/fhir/cdm/StructureDefinition/source-record-id
• http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version
• http://ibm.com/fhir/cdm/StructureDefinition/process-client-id
• https://standards.digital.health.nz/ns/central-region/l4h-template-version
• https://standards.digital.health.nz/ns/central-region/nz-ethnicity
• https://standards.digital.health.nz/ns/central-region/nz-residency
• https://standards.digital.health.nz/ns/central-region/religion
• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.extension.value[x].coding
• The element 1 is sliced based on the value of Patient.extension.extension.value[x].coding
• The element 1 is sliced based on the value of Patient.deceased[x]