Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules		0..0
language		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
modifierExtension		0..0
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	S	0..1	Identifier	The persons current NHI number
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
identifier:dormantNHI	S	0..*	Identifier	NHI numbers that have been deprecated
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: old
system		0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
active		0..0
name		1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
telecom
Slices for extension				Content/Rules for all slices
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
contact-point-purpose		0..1	CodeableConcept	A specific purpose for which this ContactPoint dataType would be used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred)
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
address		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
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
multipleBirth[x]		0..0
photo		0..0
contact
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientRelationshipType (extensible)
communication
preferred		0..0
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
Slices for extension				Content/Rules for all slices
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
managingOrganization		0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
link		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.contact.relationship	extensible	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	SΣ	0..1	Identifier	The persons current NHI number
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
identifier:dormantNHI	SΣ	0..*	Identifier	NHI numbers that have been deprecated
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
name	Σ	1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address		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
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
Slices for extension				Content/Rules for all slices
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
managingOrganization	Σ	0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dormantNHI.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	SΣ	0..1	Identifier	The persons current NHI number
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	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: 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)
identifier:dormantNHI	SΣ	0..*	Identifier	NHI numbers that have been deprecated
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	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: 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)
name	Σ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
contact-point-purpose		0..1	CodeableConcept	A specific purpose for which this ContactPoint dataType would be used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address		0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	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	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Should be the ISO 3166 code
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
contact	C	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientRelationshipType (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		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
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
managingOrganization	Σ	0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:dormantNHI.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dormantNHI.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.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	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype 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 Additional Bindings Purpose AllLanguages Max Binding 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.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)
• Northern Region PractitionerRole profile (http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPractitionerRole)
• Northern Region Organization profile (http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionOrganization)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
• http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
• http://hl7.org.nz/fhir/StructureDefinition/current-occupation
• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
• http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
• http://hl7.org.nz/fhir/StructureDefinition/nz-residency
• http://hl7.org/fhir/StructureDefinition/iso21090-preferred
• http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
• http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
• http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
• http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier (Open at End)

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules		0..0
language		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
modifierExtension		0..0
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	S	0..1	Identifier	The persons current NHI number
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official
system		0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
identifier:dormantNHI	S	0..*	Identifier	NHI numbers that have been deprecated
use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: old
system		0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
active		0..0
name		1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
telecom
Slices for extension				Content/Rules for all slices
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
contact-point-purpose		0..1	CodeableConcept	A specific purpose for which this ContactPoint dataType would be used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred)
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
address		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
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
multipleBirth[x]		0..0
photo		0..0
contact
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientRelationshipType (extensible)
communication
preferred		0..0
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
Slices for extension				Content/Rules for all slices
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
managingOrganization		0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
link		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.contact.relationship	extensible	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	SΣ	0..1	Identifier	The persons current NHI number
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
identifier:dormantNHI	SΣ	0..*	Identifier	NHI numbers that have been deprecated
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/nhi-id
name	Σ	1..*	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address		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
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
Slices for extension				Content/Rules for all slices
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
managingOrganization	Σ	0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dormantNHI.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
nz-ethnicity		0..6	CodeableConcept	The persons ethnicity (up to 6) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
birth-place		0..1	Address	Where the person was born URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
patient-iwi		0..*	CodeableConcept	The Iwi the person is associated with URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
nz-citizenship		0..1	(Complex)	The New Zealand citizenship status URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
current-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
residency-status		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open At End by pattern:use
identifier:NHI	SΣ	0..1	Identifier	The persons current NHI number
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	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: 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)
identifier:dormantNHI	SΣ	0..*	Identifier	NHI numbers that have been deprecated
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	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: 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)
name	Σ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
preferred		0..1	boolean	Preferred URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
contact-point-purpose		0..1	CodeableConcept	A specific purpose for which this ContactPoint dataType would be used URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose Binding: ContactPoint purpose (preferred)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address		0..*	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
authorized-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
validated-by-patient		0..1	boolean	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	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	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Should be the ISO 3166 code
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
contact	C	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientRelationshipType (extensible)
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		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
generalPractitioner		0..*	Reference(Northern Region PractitionerRole profile)	Patient's nominated primary care provider
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
gp-practice-enrollment-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
managingOrganization	Σ	0..1	Reference(Northern Region Organization profile)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:dormantNHI.use	required	Fixed Value: old http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:dormantNHI.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.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	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.contact.relationship	extensible	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype 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 Additional Bindings Purpose AllLanguages Max Binding 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.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)
• Northern Region PractitionerRole profile (http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPractitionerRole)
• Northern Region Organization profile (http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionOrganization)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
• http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
• http://hl7.org.nz/fhir/StructureDefinition/current-occupation
• http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
• http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
• http://hl7.org.nz/fhir/StructureDefinition/nz-residency
• http://hl7.org/fhir/StructureDefinition/iso21090-preferred
• http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
• http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
• http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
• http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier (Open at End)