| Left: | NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient) |
| Right: | NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient) |
| Information | StructureDefinition.date | Values for date differ: '2026-07-24T15:52:23+12:00' vs '2026-10-15T22:28:14+00:00' |
| Information | StructureDefinition.jurisdiction | Added the item 'null#null' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Patient | ||
copyright | |||
date | 2026-07-24T15:52:23+12:00 | 2026-10-15T22:28:14+00:00 |
|
description | The base New Zealand Patient profile | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | null#null |
| |
kind | resource | ||
name | NzPatient | ||
publisher | HL7 New Zealand | ||
purpose | Describe the Base New Zealand Patient resource profileI | ||
status | active | ||
title | NZ Patient | ||
type | Patient | ||
url | http://hl7.org.nz/fhir/StructureDefinition/NzPatient | ||
version | 1.0.0 | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: nz-pat-1 | C | 0..* | Patient | Information about an individual or animal receiving health care services Constraints: nz-pat-1 | |||||||||
![]() ![]() | 0..1 | id | Logical id of this artifact | 0..1 | id | Logical id of this artifact | |||||||||||
![]() ![]() | 0..1 | Meta | Metadata about the resource | 0..1 | Meta | Metadata about the resource | |||||||||||
![]() ![]() | 0..1 | uri | A set of rules under which this content was created | 0..1 | uri | A set of rules under which this content was created | |||||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
![]() ![]() | 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 | 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 | |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | 0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||
![]() ![]() | 0..* | Extension | Extensions that cannot be ignored | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
![]() ![]() | 0..* | 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 | 0..* | 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 | |||||||||||
![]() ![]() | 0..1 | boolean | Whether this patient's record is in active use | 0..1 | boolean | Whether this patient's record is in active use | |||||||||||
![]() ![]() | 0..* | HumanName | A name associated with the patient | 0..* | HumanName | A name associated with the patient | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | |||||||||||
![]() ![]() ![]() | 0..1 | string | Text representation of the full name | 0..1 | string | Text representation of the full name | |||||||||||
![]() ![]() ![]() | 0..1 | string | Family name (often called 'Surname') | 0..1 | string | Family name (often called 'Surname') | |||||||||||
![]() ![]() ![]() | 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 | 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 | |||||||||||
![]() ![]() ![]() | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||
![]() ![]() ![]() | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||
![]() ![]() ![]() | 0..1 | Period | Time period when name was/is in use | 0..1 | Period | Time period when name was/is in use | |||||||||||
![]() ![]() | 0..* | ?? | A contact detail for the individual | 0..* | ?? | A contact detail for the individual | |||||||||||
![]() ![]() | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||||
![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | 0..1 | string | Primitive value for code | 0..1 | string | Primitive value for code | |||||||||||
![]() ![]() | 0..1 | date | The date of birth for the individual | 0..1 | date | The date of birth for the individual | |||||||||||
![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | 0..1 | date | Primitive value for date | 0..1 | date | Primitive value for date | |||||||||||
![]() ![]() | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |||||||||||
![]() ![]() | 0..* | ?? | An address for the individual | 0..* | ?? | An address for the individual | |||||||||||
![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | |||||||||||
![]() ![]() | 0..1 | boolean, integer | Whether patient is part of a multiple birth | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |||||||||||
![]() ![]() | 0..* | Attachment | Image of the patient | 0..* | Attachment | Image of the patient | |||||||||||
![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||
![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | 0..1 | HumanName | A name associated with the contact person | |||||||||||
![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | 0..* | ContactPoint | A contact detail for the person | |||||||||||
![]() ![]() ![]() | 0..1 | Address | Address for the contact person | 0..1 | Address | Address for the contact person | |||||||||||
![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||||
![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | |||||||||
![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||
![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language.
| 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language.
| |||||||||||
![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||||||
![]() ![]() | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||||||||
![]() ![]() | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
![]() ![]() ![]() | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||||||||
![]() ![]() ![]() | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | |||||||||||
Documentation for this format | |||||||||||||||||