FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: NZPS-Patient

The NZ International Patient Summary patient resource. This profile derives from the International Patient summary with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

Usages:

• Use this Profile: NZPS-Bundle
• Refer to this Profile: NZPS-Composition and NZPS-Observation-Vaping-Status

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..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:genderIdentity		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]]	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
extension:personalPronouns		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]]	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
identifier:NHI	SOΣ	0..1	Identifier	The currently active NHI Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:dormant	SOΣ	0..*	Identifier	NHI identifiers that have been deprecated for this Person Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!Σ	0..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor Source SHALL:populate Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
family	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
given	SOΣ	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 Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
telecom	SOΣ	0..*	NzContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
gender	SOΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
birthDate	SOΣ	1..1	date	The date of birth for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	NzAddress	An address for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
generalPractitioner	SO	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​use	Base	required	IdentifierUse	📍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.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

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

This structure is derived from PatientUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	S	0..1	Identifier	The currently active NHI
use		0..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:dormant	S	0..*	Identifier	NHI identifiers that have been deprecated for this Person
use		0..1	code	fixed to old Fixed Value: old
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
telecom		0..*	NzContactPoint	A contact detail for the individual
gender
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
address		0..*	NzAddress	An address for the individual
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
nz-pat-1	error	Patient	A patient can only have a one official (i.e. 'live') NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderIdentity		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]]	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
extension:personalPronouns		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]]	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
identifier:NHI	SOΣ	0..1	Identifier	The currently active NHI Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	fixed to official 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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:dormant	SOΣ	0..*	Identifier	NHI identifiers that have been deprecated for this Person Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	fixed to old 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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor Source SHALL:populate Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
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	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
family	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
given	SOΣ	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 Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
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	SOΣ	0..*	NzContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
gender	SOΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	SOΣ	1..1	date	The date of birth for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	NzAddress	An address for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
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
preferred		0..1	boolean	Language preference indicator
generalPractitioner	SO	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​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.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
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()
nz-pat-1	error	Patient	A patient can only have a one official (i.e. 'live') NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientUvIps

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• Common NZ ContactPoint datatype (http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
• http://hl7.org.nz/fhir/StructureDefinition/maori-descent
• http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org.nz/fhir/StructureDefinition/gender-original-text

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:genderIdentity		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]]	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
extension:personalPronouns		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]]	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
identifier:NHI	SOΣ	0..1	Identifier	The currently active NHI Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!Σ	0..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:dormant	SOΣ	0..*	Identifier	NHI identifiers that have been deprecated for this Person Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!Σ	0..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor Source SHALL:populate Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
use	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
family	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
given	SOΣ	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 Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
telecom	SOΣ	0..*	NzContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
gender	SOΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
birthDate	SOΣ	1..1	date	The date of birth for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	NzAddress	An address for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
generalPractitioner	SO	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​use	Base	required	IdentifierUse	📍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.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

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

Differential View

This structure is derived from PatientUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Slices for identifier		0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	S	0..1	Identifier	The currently active NHI
use		0..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
identifier:dormant	S	0..*	Identifier	NHI identifiers that have been deprecated for this Person
use		0..1	code	fixed to old Fixed Value: old
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
telecom		0..*	NzContactPoint	A contact detail for the individual
gender
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
address		0..*	NzAddress	An address for the individual
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
nz-pat-1	error	Patient	A patient can only have a one official (i.e. 'live') NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	PatientUvIps	Information about an individual or animal receiving health care services This profile also imposes the profile NZ Patient Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderIdentity		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1]]	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.3.0-ballot-tc1
extension:personalPronouns		0..*	?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1]]	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.3.0-ballot-tc1
extension:ethnicity		0..6	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:maori-descent		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/maori-descent Binding: Māori Descent (preferred)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:birth-country		0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
identifier:NHI	SOΣ	0..1	Identifier	The currently active NHI Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	fixed to official 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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:dormant	SOΣ	0..*	Identifier	NHI identifiers that have been deprecated for this Person Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	fixed to old 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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SOΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1 Obligations Actor Source SHALL:populate Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
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	?!SOΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
text	SOΣ	0..1	string	Text representation of the full name Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
family	SOΣ	0..1	string	Family name (often called 'Surname') Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
given	SOΣ	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 Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
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	SOΣ	0..*	NzContactPoint	A contact detail for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
gender	SOΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:originalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	SOΣ	1..1	date	The date of birth for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SOΣ	0..*	NzAddress	An address for the individual Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
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
preferred		0..1	boolean	Language preference indicator
generalPractitioner	SO	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider Obligations Actor Source SHALL:populate-if-known Creator (IPS) from Patient (IPS) SHALL:handle Consumer (IPS) from Patient (IPS) SHOULD:display Consumer (IPS) from Patient (IPS)
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
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
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	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	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:NHI.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:dormant.​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.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
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present	family.exists() or given.exists() or text.exists()
nz-pat-1	error	Patient	A patient can only have a one official (i.e. 'live') NHI	Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientUvIps

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• Common NZ ContactPoint datatype (http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
• http://hl7.org.nz/fhir/StructureDefinition/maori-descent
• http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org.nz/fhir/StructureDefinition/gender-original-text

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier

Other representations of profile: CSV, Excel, Schematron