HL7® FHIR® New Zealand Base Implementation Guide
1.1.0 - CI Build

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

Resource Profile: NZ Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzPatient Version: 1.1.0
Active as of 2022-05-19 Realm: New Zealand flag Computable Name: NzPatient

The base New Zealand Patient profile

Describe the Base New Zealand Patient resource profileI

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
... nz-citizenship 0..1(Complex)Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... domicile-code 0..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:NHI S0..1IdentifierThe currently active NHI
..... use 0..1codefixed to 'official'
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
... telecom 0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
... nz-citizenship 0..1(Complex)Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... dhb 0..1CodeableConceptDistrict 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


... domicile-code 0..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:NHI SΣ0..1IdentifierThe currently active NHI
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codefixed to 'official'
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom I0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... identifier:NHI Σ0..1IdentifierThe currently active NHI

doco Documentation for this format

This structure is derived from Patient

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
... nz-citizenship 0..1(Complex)Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... domicile-code 0..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:NHI S0..1IdentifierThe currently active NHI
..... use 0..1codefixed to 'official'
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
... telecom 0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptNZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)
... nz-citizenship 0..1(Complex)Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... dhb 0..1CodeableConceptDistrict 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


... domicile-code 0..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by value:system
.... identifier:NHI SΣ0..1IdentifierThe currently active NHI
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codefixed to 'official'
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom I0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.identifier:NHI.userequiredFixed Value: official
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType