Northern Region Implementation Guide
0.4.6 - CI Build

Northern Region Implementation Guide, published by healthAlliance. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/northernRegion/ and changes regularly. See the Directory of published versions

Resource Profile: Northern Region Patient profile

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPatient Version: 0.4.6
Active as of 2024-01-24 Realm: New Zealand flag Computable Name: NorthernRegionPatient

Represents Patient data exposed through the Northern Region APIs.

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules 0..0
... language 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-iwi 0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... modifierExtension 0..0
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI S0..1IdentifierThe persons current NHI number
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
.... identifier:dormantNHI S0..*IdentifierNHI numbers that have been deprecated
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
... active 0..0
... name 1..*HumanNameA name associated with the patient
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... telecom
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... contact-point-purpose 0..1CodeableConceptA specific purpose for which this ContactPoint dataType would be used
URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
Binding: ContactPoint purpose (preferred)
... gender 1..1codemale | female | other | unknown
... birthDate 1..1dateThe date of birth for the individual
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
... multipleBirth[x] 0..0
... photo 0..0
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientRelationshipType (extensible)
... communication
.... preferred 0..0
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
... managingOrganization 0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record
... link 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.contact.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
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..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣ0..1IdentifierThe persons current NHI number
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
.... identifier:dormantNHI SΣ0..*IdentifierNHI numbers that have been deprecated
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
... name Σ1..*HumanNameA name associated with the patient
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..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)
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... country-name 0..1stringThe name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
... managingOrganization Σ0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:dormantNHI.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-iwi 0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣ0..1IdentifierThe persons current NHI number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
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 Σ0..1uriThe namespace for the identifier value
Required Pattern: 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)
.... identifier:dormantNHI SΣ0..*IdentifierNHI numbers that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... 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 Σ0..1uriThe namespace for the identifier value
Required Pattern: 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)
... name Σ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... contact-point-purpose 0..1CodeableConceptA specific purpose for which this ContactPoint dataType would be used
URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
Binding: ContactPoint purpose (preferred)
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..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)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... country-name 0..1stringThe name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringShould be the ISO 3166 code
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... contact C0..*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: PatientRelationshipType (extensible)
.... 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 C0..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
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:dormantNHI.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:dormantNHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.generalPractitioner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from Patient

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules 0..0
... language 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-iwi 0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... modifierExtension 0..0
... Slices for identifier 0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI S0..1IdentifierThe persons current NHI number
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
.... identifier:dormantNHI S0..*IdentifierNHI numbers that have been deprecated
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: old
..... system 0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
... active 0..0
... name 1..*HumanNameA name associated with the patient
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... telecom
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... contact-point-purpose 0..1CodeableConceptA specific purpose for which this ContactPoint dataType would be used
URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
Binding: ContactPoint purpose (preferred)
... gender 1..1codemale | female | other | unknown
... birthDate 1..1dateThe date of birth for the individual
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
... multipleBirth[x] 0..0
... photo 0..0
... contact
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientRelationshipType (extensible)
... communication
.... preferred 0..0
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
... managingOrganization 0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record
... link 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.contact.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard

Key Elements View

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..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣ0..1IdentifierThe persons current NHI number
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
.... identifier:dormantNHI SΣ0..*IdentifierNHI numbers that have been deprecated
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: https://standards.digital.health.nz/ns/nhi-id
... name Σ1..*HumanNameA name associated with the patient
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..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)
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... country-name 0..1stringThe name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
... managingOrganization Σ0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:dormantNHI.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nz-ethnicity 0..6CodeableConceptThe persons ethnicity (up to 6)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (L4) (preferred)
... birth-place 0..1AddressWhere the person was born
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-iwi 0..*CodeableConceptThe Iwi the person is associated with
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... nz-citizenship 0..1(Complex)The New Zealand citizenship status
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
... current-occupation 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/current-occupation
... interpreter-required 0..1booleanWhether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... residency-status 0..1(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open At End by pattern:use
.... identifier:NHI SΣ0..1IdentifierThe persons current NHI number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
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 Σ0..1uriThe namespace for the identifier value
Required Pattern: 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)
.... identifier:dormantNHI SΣ0..*IdentifierNHI numbers that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... 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 Σ0..1uriThe namespace for the identifier value
Required Pattern: 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)
... name Σ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... contact-point-purpose 0..1CodeableConceptA specific purpose for which this ContactPoint dataType would be used
URL: http://hl7.org.nz/fhir/StructureDefinition/contactpoint-purpose
Binding: ContactPoint purpose (preferred)
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..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)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... nz-geocode 0..1(Complex)A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
.... suburb 0..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... country-name 0..1stringThe name of the country. The ISO code should be in the country property
URL: http://hl7.org.nz/fhir/StructureDefinition/country-name
.... authorized-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
.... validated-by-patient 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringShould be the ISO 3166 code
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... contact C0..*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: PatientRelationshipType (extensible)
.... 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 C0..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
... generalPractitioner 0..*Reference(Northern Region PractitionerRole profile)Patient's nominated primary care provider
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... gp-practice-enrollment-date 0..1dateExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Northern Region Organization profile)Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:dormantNHI.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:dormantNHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.generalPractitioner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from Patient

 

Other representations of profile: CSV, Excel, Schematron