HL7® FHIR® New Zealand Base Implementation Guide
0.2.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 0.2.0). This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

Extensions


Extensions defined in this guide

IdUrlContext of UseDescriptionPurpose FMM Status
additional-authorisation http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification
Additional authorisations that a practitioner is authorised to perform 0 draft
alias-type http://hl7.org.nz/fhir/StructureDefinition/alias-type
Location.alias
Organization.alias
Indicates the type of alias name. VS Binding is done by the profile. 0 draft
authorized-by-patient http://hl7.org.nz/fhir/StructureDefinition/authorized-by-patient
Address
ContactPoint
If true, then indicates that the patient as authorized the use of this address or telecom to contact them. 0 draft
building-name http://hl7.org.nz/fhir/StructureDefinition/building-name
Address
The name of a building cited in an address. 0 active
condition-on-practice http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification
A full description of the conditions the health practitioner is subject to in relation to their scope of practice. 0 active
contactpoint-other http://hl7.org.nz/fhir/StructureDefinition/contactpoint-other
ContactPoint
Other values for the ContactPoint system 0 draft
current-occupation http://hl7.org.nz/fhir/StructureDefinition/current-occupation
Patient
The current occupation for the patient 0 draft
death-date http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner
The date the person died. The date the person died. (def) 0 draft
dhb http://hl7.org.nz/fhir/StructureDefinition/dhb
HealthcareService
Location
Patient
District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related District Health Board. 3 active
domicile-code http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Patient
NZ Domicile Code. Derived from a patient's primary physical, home address. 0 active
edi-address http://hl7.org.nz/fhir/StructureDefinition/edi-address
ContactPoint.system
Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. 0 active
educational-qualification http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner
Educational qualifications. 0 draft
funded-programme http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location
Organization
HealthcareService
Funded NZ Healthcare Programmes Details of a NZ Healthcare Funded Programme relevant to its implementation status at an individual organisation, facility or service. 1 active
information-source http://hl7.org.nz/fhir/StructureDefinition/information-source
Patient.name
Patient.birthDate
The official source of information held about a patient. 0 active
location-established http://hl7.org.nz/fhir/StructureDefinition/location-established
Location
The period over which the location is open 0 draft
long-term-condition http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
Condition
Long Term Condition Indicator. A long term condition can be defined as any ongoing, long term or recurring conditions that can have a significant impact on people’s lives. Long term condition indicator (see https://www.health.govt.nz/our-work/diseases-and-conditions/long-term-conditions). 1 active
nz-citizenship http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
Patient
New Zealand citizenship 0 active
nz-ethnicity http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient
Practitioner
RelatedPerson
The ethnicity of the patient. Level 4 codes preferred (most detailed). 0 active
nz-geocode http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Address
New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode. 0 active
nz-residency-status http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
Patient
NZ Residency Status 0 draft
nzeps-long-term-medication http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication
MedicationRequest
MedicationStatement
NZePS Long Term Medication Indicator This has specific uses in NZ Pharmacy and GP systems for funding and clinical purposes. It is also part of the HISO 10041.1 standard for Medication Lists. 2 active
nzeps-supply-period-reason http://hl7.org.nz/fhir/StructureDefinition/nzeps-supply-period-reason
MedicationRequest
The reason for a non-standard Supply Period. The reason for a non-standard supply period, e.g. the patient going abroad. 1 active
nzeps-unusual-dose-quantity http://hl7.org.nz/fhir/StructureDefinition/nzeps-unusual-dose-quantity
MedicationRequest
NZePS Unusual Dose Quantity Indicator Indicates if an unusual dose quantity has been prescribed deliberately. 1 active
organization-established http://hl7.org.nz/fhir/StructureDefinition/organization-established
Organization
The period over which the Organization is active 0 draft
pho http://hl7.org.nz/fhir/StructureDefinition/pho
HealthcareService
Location
Patient
Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP). Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related Primary Healthcare Organisation. 1 active
practitionerRole-creator http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
PractitionerRole
The organisation and person that created this role 0 draft
practitionerRole-status http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status
PractitionerRole
The status of the role - active,ended 0 draft
registration-initial-date http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification
The date the practitioner first became registered with the Responsible Authority or professional body 0 active
registration-status-code http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification
An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body. 0 active
scope-of-practice http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification
The type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body. 0 active
sex-at-birth http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Patient
A person’s sex at the time of their birth (considered to be immutable). 0 draft
suburb http://hl7.org.nz/fhir/StructureDefinition/suburb
Address
Suburb element of a NZ Address. Required as FHIR Base Address Type does not contain an element for Suburb (only District or State which, in population terms, are both broader than City - whereas Suburb is narrower). 1 active
validated-by-patient http://hl7.org.nz/fhir/StructureDefinition/validated-by-patient
Address
ContactPoint
If true, then indicates that the patient as indicated that the data is correct. Defined by healthAlliance 0 draft

Extensions used but defined elsewhere

PathUrlDescriptionIG where defined