Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Slices for extension				Content/Rules for all slices
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
telecom	SC	1..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
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.
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
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.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..0
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
name		0..0
telecom	S	1..*	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
period		0..0
birthDate		0..0
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0
address		0..0
maritalStatus		0..0
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
managingOrganization		0..0
link		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
telecom	SC	1..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
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.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags 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.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 4 elements
Fixed: 1 element
Prohibited: 20 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.2.0

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.multipleBirth[x]

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Slices for extension				Content/Rules for all slices
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
telecom	SC	1..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
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.
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
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.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..0
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
name		0..0
telecom	S	1..*	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
period		0..0
birthDate		0..0
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		0..0
address		0..0
maritalStatus		0..0
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirth[x]:multipleBirthBoolean		0..0
photo		0..0
contact		0..0
communication		0..0
generalPractitioner		0..0
managingOrganization		0..0
link		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
telecom	SC	1..*	NzContactPoint	Details of a Technology mediated contact point (phone, fax, email, etc.) Constraints: cpt-2
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.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
Slices for deceased[x]	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
Slices for multipleBirth[x]		0..1	integer	Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags 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.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 4 elements
Fixed: 1 element
Prohibited: 20 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired|5.2.0

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.multipleBirth[x]