HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: SA Patient

The patient who is the subject of a Special Authority Application. Derived from NZ Base NzPatient (D4), which supplies the NzAddress datatype and the NZ Base suburb extension.

The NHI is mandatory. Suburb is carried only in the NZ Base suburb extension - consumers SHALL NOT fall back to Address.district or parse Address.line. NHI addresses are not always validated (no fixed abode, overseas and unknown addresses), so suburb is not treated as mandatory. NzAddress building name, domicile code and geocode have no home in the Application Data schema and are dropped by the API.

Usages:

• Use this Profile: SA Submission Bundle
• Refer to this Profile: SA Application ClaimResponse, SA Approval ClaimResponse, SA Claim and SA QuestionnaireResponse
• Examples for this Profile: Patient/sa-example-patient

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:NHI	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id (no extensions allowed)
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	NzAddress	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.1
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
Patient.identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient
Patient.Slices for identifier				Content/Rules for all slices
Patient.Slices for identifier.identifier:NHI	S This element must be supported.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name	S This element must be supported.	0..*	HumanName	A name associated with the patient
Patient.name.use	S This element must be supported.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text	S This element must be supported.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported.	0..*	string	Given names (not always 'first'). Includes middle names
Patient.name.prefix	S This element must be supported.	0..*	string	Parts that come before the name
Patient.name.suffix	S This element must be supported.	0..*	string	Parts that come after the name
Patient.birthDate	S This element must be supported.	0..1	date	The date of birth for the individual
Patient.address	S This element must be supported.	0..*	NzAddress	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	Suburb	NZ Suburb
Patient.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc.
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc.
Patient.address.postalCode	S This element must be supported.	0..1	string	Postal code for area
Patient.address.country	S This element must be supported.	0..1	string	Should be the ISO 3166 code
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
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:NHI	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id (no extensions allowed)
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	NzContactPoint	A contact detail for the individual
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.gender.id		0..1	string	xml:id (or equivalent in JSON)
Patient.gender.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.gender.Slices for extension.extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
Patient.gender.value		0..1	string	Primitive value for code
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	NzAddress	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.state	Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.1
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from NzPatient

Summary

Mandatory: 3 elements
Must-Support: 17 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:NHI	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id (no extensions allowed)
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.name.Slices for extension				Content/Rules for all slices
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension				Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	NzAddress	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.1
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	NzPatient	Information about an individual or animal receiving health care services
Patient.identifier	S This element must be supported.	1..*	Identifier	An identifier for this patient
Patient.Slices for identifier				Content/Rules for all slices
Patient.Slices for identifier.identifier:NHI	S This element must be supported.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported.	1..1	string	The value that is unique
Patient.name	S This element must be supported.	0..*	HumanName	A name associated with the patient
Patient.name.use	S This element must be supported.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
Patient.name.text	S This element must be supported.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported.	0..*	string	Given names (not always 'first'). Includes middle names
Patient.name.prefix	S This element must be supported.	0..*	string	Parts that come before the name
Patient.name.suffix	S This element must be supported.	0..*	string	Parts that come after the name
Patient.birthDate	S This element must be supported.	0..1	date	The date of birth for the individual
Patient.address	S This element must be supported.	0..*	NzAddress	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	Suburb	NZ Suburb
Patient.address.line	S This element must be supported.	0..*	string	Street name, number, direction & P.O. Box etc.
Patient.address.city	S This element must be supported.	0..1	string	Name of city, town etc.
Patient.address.postalCode	S This element must be supported.	0..1	string	Postal code for area
Patient.address.country	S This element must be supported.	0..1	string	Should be the ISO 3166 code
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Patient.Slices for extension.extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient.Slices for extension.extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Patient.Slices for extension.extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.Slices for extension.extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
Patient.Slices for extension.extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
Patient.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Patient.Slices for extension.extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
Patient.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Patient.Slices for extension.extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
Patient.Slices for extension.extension:interpreter-required		0..1	boolean	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:NHI	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	An identifier for this patient
Patient.Slices for identifier.identifier:NHI.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:NHI.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:NHI.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
Patient.Slices for identifier.identifier:NHI.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.Slices for identifier.identifier:NHI.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id (no extensions allowed)
Patient.Slices for identifier.identifier:NHI.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Patient.Slices for identifier.identifier:NHI.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:NHI.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..*	HumanName	A name associated with the patient
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.name.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	S This element must be supported. Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	S This element must be supported. Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	S This element must be supported. Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	NzContactPoint	A contact detail for the individual
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.gender.id		0..1	string	xml:id (or equivalent in JSON)
Patient.gender.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.gender.Slices for extension.extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
Patient.gender.value		0..1	string	Primitive value for code
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime	?! This element is a modifier element. Σ This element is included in summaries.	0..1	dateTime	Indicates if the individual is deceased or not
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.Slices for extension.extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
Patient.Slices for deceased[x].deceased[x]:deceasedDateTime.value		0..1	dateTime	Primitive value for dateTime
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	NzAddress	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Patient.address.Slices for extension.extension:suburb	S This element must be supported.	0..1	string	NZ Suburb URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Patient.address.Slices for extension.extension:building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Patient.address.Slices for extension.extension:domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
Patient.address.Slices for extension.extension:country-name		0..1	string	The name of the country. The ISO code should be in the country property URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.state	Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Should be the ISO 3166 code
Patient.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.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
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier:NHI.​use	Base	required	Valid use values for NHI	📦1.0.0	HL7® FHIR® New Zealand Base Implementation Guide v3.1
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from NzPatient

Summary

Mandatory: 3 elements
Must-Support: 17 elements

Other representations of profile: CSV, Excel, Schematron