Extensions, ValueSets, CodeSystems and Identifiers defined for New Zealand Implementation Guides

Summary generated: Wed Nov 25 2020 15:32:38 GMT+1300 (New Zealand Daylight Time)

Profiles

IGTitleUrlDescription
nhi NHI Address http://hl7.org.nz/fhir/StructureDefinition/NhiAddress Adds additional, NHI specific extensions
nhi NHI Patient http://hl7.org.nz/fhir/StructureDefinition/NhiPatient The Patient resource exposed by the NHI.
nhi Common NZ Address datatype http://hl7.org.nz/fhir/StructureDefinition/NzAddress Adds building name, suburb, domicile code and geocode to the Address datatype
hpi HPI Endpoint http://hl7.org.nz/ig/fhir/StructureDefinition/HpiEndpoint
hpi HPI Location http://hl7.org.nz/ig/fhir/StructureDefinition/HpiLocation A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility.
hpi HPI Organization http://hl7.org.nz/ig/fhir/StructureDefinition/HpiOrganization An entity that provides services of interest to, or is involved in, the business of health care service provision.
hpi HPI Practitioner http://hl7.org.nz/ig/fhir/StructureDefinition/HpiPractitioner The practitioner exposed by the HPI. This is the person who delivers care - regardless of qualification.
hpi HPI Practitioner role http://hl7.org.nz/ig/fhir/StructureDefinition/HpiPractitionerRole The practitioner role exposed by the HPI. Used to connect Practitioners with Organizations and Locations, indicating the role they have. A single Practitioner can have roles with multple organizations.
cca ActivityDefinition http://hl7.org.nz/fhir/StructureDefinition/CcaActivityDefinition CCA Regimen Activity Definition.
cca PlanDefinition http://hl7.org.nz/fhir/StructureDefinition/CcaPlanDefinition CCA Regimen Plan Definition.

Extensions

IGIdContextUrlDescriptionUsed by
nhi birth-place
Patient
http://hl7.org.nz/fhir/StructureDefinition/birth-place The country where the person was born
nhi building-name
Address
http://hl7.org.nz/fhir/StructureDefinition/building-name Used on an adddress datatype when a building name is needed
nhi domicile-code
Address
http://hl7.org.nz/fhir/StructureDefinition/domicile-code The domicile code. Derived from the address
nhi gp-practice-enrollment-date
Patient
http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date The date that the patient was enrolled with their GP Practicce
nhi information-source
Element
http://hl7.org.nz/fhir/StructureDefinition/information-source The source of the information. Used paricularly in the NHI. Note this not the person but rather than it came from a passport for example
nhi is-primary-address
Element
http://hl7.org.nz/fhir/StructureDefinition/is-primary-address Indicates this is the primary residential address - each patient must have one and only one
nhi nhi-address-derived
Address
http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived Address elements that are directly derived from the actual address
nhi not-validated-address-reason
Element
http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason The reason why the address has not been validated
nhi nz-citizenship
Patient
http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship New Zealand citizenship
nhi nz-ethnicity
Element
http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity The ethnicity of the individual. Uses level 4 codes (most detailed).
nhi nz-geocode
Address
http://hl7.org.nz/fhir/StructureDefinition/nz-geocode The new zealand geocode. This uses a different datum from that defined in the spec for the geocode, so is an extension rather than using the element in the spec. see discussion at https://chat.fhir.org/#narrow/stream/179166-implementers/topic/geocode.20extension
nhi nz-residency-status
Patient
http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status NZ Residency status
nhi patient-iwi
Patient
http://hl7.org.nz/fhir/StructureDefinition/patient-iwi Persons Iwi affiliation
nhi sex-at-birth
Patient
http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth The persons sex when born. Is considered to be immutable
nhi suburb
Address
http://hl7.org.nz/fhir/StructureDefinition/suburb The suburb of the address. This is not the same as 'district' or 'state.
hpi additional-authorization
Practitioner.qualification
http://hl7.org.nz/fhir/StructureDefinition/additional-authorization Additional authorizations that a practitioner is authorized to perform
hpi alias-type
Location.alias
http://hl7.org.nz/fhir/StructureDefinition/alias-type Indicates the type of alias name. VS Binding is done by the profile.
hpi condition-on-practice
Practitioner.qualification
http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice A full description of the conditions the health practitioner is subject to in relation to their scope of practice.
hpi death-date
Practitioner
http://hl7.org.nz/fhir/StructureDefinition/death-date The date the person died.
hpi dhb
Patient
Location
http://hl7.org.nz/fhir/StructureDefinition/dhb The District Health Board the patient resides in and a Location is associated with. It is derived from the patient's primary residential address (not updated directly).
hpi educational-qualification
Practitioner
http://hl7.org.nz/fhir/StructureDefinition/educational-qualification Educational qualifications.
hpi location-established
Location
http://hl7.org.nz/fhir/StructureDefinition/location-established The period over which the location is open
hpi organization-established
Organization
http://hl7.org.nz/fhir/StructureDefinition/organization-established The period over which the Organization is active
hpi practitionerRole-creator
PractitionerRole
http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator The organisation and person that created this role
hpi practitionerRole-status
PractitionerRole
http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status The status of the role - active,ended
hpi registration-initial-date
Practitioner.qualification
http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date The date the practitioner first became registered with the Responsible Authority or professional body
hpi registration-status-code
Practitioner.qualification
http://hl7.org.nz/fhir/StructureDefinition/registration-status-code An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.
hpi scope-of-practice
Practitioner.qualification
http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice The type or range of health services a practitioner is authorized to perform, as determined by the Responsible Authority or professional body.
cca sact-additional-plan-status
PlanDefinition.status
http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Additional status values for PlanDefinition. Currently only a single value - review - indicating that a regimen is published and available to be used, but there is still a review being performed, so could change. In most situations the value of the status element itself will be 'active'
cca sact-administration-site
ActivityDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-administration-site The physical Location where the medication administration occurs (eg home or clinic)
cca sact-disclaimer
PlanDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer A disclaimer for use of this Plan
cca sact-location-medication-collection
ActivityDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-location-medication-collection The physical Location where the medication can be collection prior to collection
cca sact-off-label
ActivityDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-off-label Indicates that the medication is being used for a purpose for which it has not been specifically approved
cca sact-plan-instructions
PlanDefinition
PlanDefinition.action
PlanDefinition.action.action
http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions Specific instructions for use of the regimen overall, or for the individual cycles
cca sact-regimen-type
PlanDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type The overall type of the regimen - eg FOLFOX
cca sact-replaced-by
PlanDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by When a Plan has been deprecated (superceeded or discontinued), refers to the one that replaces it, if any
cca sact-support-factor
PlanDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor Support factors needed during treatment
cca sact-timing-of-days
Element
http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days Allows specific days to be indicated in a component of a regimen cycle. extends the idea of UV extension: http://hl7.org/fhir/extension-timing-daysofcycle.html by adding instructions
cca sact-treatment-intent
PlanDefinition
http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-intent The intent of the regimen - what is its purpose

ValueSets

IGNameUrl (CodeSystems)DescriptionWhere used
nhi AddressNotValidatedReason https://standards.digital.health.nz/fhir/ValueSet/address-not-validated-reason-code The reason why the address was not validated
nhi Iwi https://standards.digital.health.nz/fhir/ValueSet/iwi-code New Zealand iwi codes
nhi DomicileCode https://standards.digital.health.nz/fhir/ValueSet/domicile-code domicileCode
nhi Ethnicity https://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code Level 4 ethnicity codes
nhi InformationSource https://standards.digital.health.nz/fhir/ValueSet/information-source-code The source from where the value of this item was sourced
nhi AdditionalSex https://standards.digital.health.nz/fhir/ValueSet/nz-additional-sex-code Additional sex values for Patient
nhi NzCitizenshipStatus https://standards.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code Status of citizenship in NZ
nhi NZResidencyStatus https://standards.digital.health.nz/fhir/ValueSet/nz-residency-status-code Is the person a NZ resident
hpi DHB https://standards.digital.health.nz/fhir/ValueSet/dhb-code District Health Board HPI Organisation Identifer
hpi EndpointPayloadType https://standards.digital.health.nz/fhir/ValueSet/endpoint-payload-type-code Type of Payload in an Endpoint
hpi AddressUse https://standards.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code Use values for an Address
hpi ContactPointUse https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code Use values for a ContactPoint
hpi HumanNameUse https://standards.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code Use values for a HumanName
hpi IdentifierUse https://standards.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code Use values for an identifier
hpi PractitionerRoleStatusReason https://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code The reason for the current status of PractitionerRole
hpi LocationAliasType https://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code The set of alias types that apply to Locations
hpi LocationStatus https://standards.digital.health.nz/fhir/ValueSet/hpi-location-status-code Status of Location - is it still in use
hpi LocationType https://standards.digital.health.nz/fhir/ValueSet/location-type-code Type of Location
hpi OrganizationAliasType https://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code The set of alias types that apply to Organizations
hpi PractitionerAdditionalAuthorization https://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code A coded type for additional authorisations
hpi RegistrationAuthority https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code Professional registration the healthcare provider has
hpi PractitionerRegistrationStatusCode https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code The code list represents the current practicing status of the Provider Person as per their registration with an RA.
hpi PractitionerScopeOfPractice https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code A coded type for professional scope of practice.
hpi PractitionerRoleCodes https://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code Coded roles that can be in a PractitionerRole
cca CancerType https://standards.digital.health.nz/fhir/ValueSet/cancer-type-code The type of Cancer
cca LocationAdministration https://standards.digital.health.nz/fhir/ValueSet/sact-administration-site-code The physical location where the administration occurred - eg at home or in a clinic
cca LocationMedicationCollection https://standards.digital.health.nz/fhir/ValueSet/sact-location-medication-collection-code The physical location where the medication can be collected on prior to administration - eg a pharmacy
cca PlanDefinitionStatus https://standards.digital.health.nz/fhir/ValueSet/sact-plan-definition-status-code Other codes used for the PlanDefinition status
cca RegimenCode https://standards.digital.health.nz/fhir/ValueSet/sact-regimen-code The type of regimen - eg FOLFOX
cca SupportFactorCode https://standards.digital.health.nz/fhir/ValueSet/sact-support-factor-code The set of possible support factors (not their values)
cca SupportFactorValue https://standards.digital.health.nz/fhir/ValueSet/sact-support-factor-value-code The set of all possible support factors values (not specific to any one factor)
cca TreatmentIntent https://standards.digital.health.nz/fhir/ValueSet/sact-treatment-intent-code The intent of the regimen - what is its purpose

CodeSystems

IGNameUrlDescription
nhi AddressNotValidated https://standards.digital.health.nz/ns/address-not-validated-reason-code The reason why the address was not validated
nhi Iwi https://standards.digital.health.nz/ns/iwi-code New Zealand iwi codes
nhi DomicileCode https://standards.digital.health.nz/ns/domicile-code domicileCode
nhi EthnicityL4 https://standards.digital.health.nz/ns/ethnic-group-level-4-code Level 4 ethnicity codes
nhi InformationSource https://standards.digital.health.nz/ns/information-source-code All possible sources of information
nhi AdditionalSex https://standards.digital.health.nz/ns/nz-additional-sex-code Additional sex values for Patient
nhi NzCitizenshipStatus https://standards.digital.health.nz/ns/nz-citizenship-status-code Status of citizenship in NZ
nhi NZResidencyStatus https://standards.digital.health.nz/ns/nz-residency-status-code NZ Residency status
hpi AliasType https://standards.digital.health.nz/ns/alias-type-code Used in Organization and Location to indicate what is the type of Alias
hpi Dhb https://standards.digital.health.nz/ns/dhb-code District Health Board Code
hpi EndpointPayloadType https://standards.digital.health.nz/ns/endpoint-payload-type-code Type of Payload in an Endpoint
hpi PractitionerRoleStatusReason https://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code The reason for the current status of PractitionerRole
hpi LocationType https://standards.digital.health.nz/ns/location-type-code Type of Location
hpi AdditionalAuthorization https://standards.digital.health.nz/ns/practitioner-additional-authorization-code Additional authorisations that a practitioner is authorised to practice or prescribe.
hpi PractitionerRegistrationAuthority https://standards.digital.health.nz/ns/practitioner-registration-authority-code Professional registration the healthcare provider has
hpi PractitionerRegistrationStatusCode https://standards.digital.health.nz/ns/practitioner-registration-status-code The code list represents the current practicing status of the Provider Person as per their registration with an RA.
hpi PractitionerRoleCodes https://standards.digital.health.nz/ns/practitioner-role-code Coded roles that can be in a PractitionerRole
hpi ScopeOfPractice https://standards.digital.health.nz/ns/practitioner-scope-of-practice-code A classification of the type or range of health services that a practitioner is authorised to provide, as determined by the Responsible Authority or other statutory authority (e.g. PHARMAC), that is, what the practitioner can or cannot do. It includes Scope of Practice as defined by the Health Practitioners Competence Assurance Act 2003, any special authorisations granted, and any conditions or limitations imposed by the Responsible Authority.
cca PlanDefinitionStatus https://standards.digital.health.nz/ns/sact-plan-definition-status-code Other codes used for the PlanDefinition status
cca RegimenCode https://standards.digital.health.nz/ns/sact-regimen-code Codes used for the regimen type
cca TreatmentIntent https://standards.digital.health.nz/ns/sact-treatment-intent-code The intent of the regimen - what is its purpose

Identifiers (from namingSystem)

IGDescriptionPreferred UrlOther identifiersResponsible
hpiChiropractic Board Register number
  • oid: 2.16.840.1.113883.2.18.70.1
HISO
hpiDental Council Register Number
  • oid: 2.16.840.1.113883.2.18.70.2
HISO
hpiDietitians Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.3
HISO
hpiHPI PractitionerRole idHISO
hpiHPI facilities
  • uri: https://standards.digital.health.nz/ns/moh-facility-id
  • uri: https://standards.digital.health.nz/id/hpi-facility Deprecated
  • oid: 2.16.840.1.113883.2.18.3.2
HISO
hpiHPI organizations
  • uri: https://standards.digital.health.nz/ns/moh-agency-id NZHIS Agency code. Deprecated
  • uri: https://standards.digital.health.nz/id/hpi-organisation Deprecated
  • oid: 2.16.840.1.113883.2.18.3.3
HISO
hpiHPI providers
  • uri: https://standards.digital.health.nz/id/hpi-person Deprecated
  • oid: 2.16.840.1.113883.2.18.3.1
HISO
hpiLegacy number for Facility (Location) National CollectionsHISO
hpiLegacy number for Organization National CollectionsHISO
hpiMedical Council of New Zealand Register Number
  • oid: 2.16.840.1.113883.2.18.41
HISO
hpiMedical Laboratory Science Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.4
HISO
hpiMedical Radiation Technologists Board Register NumberHISO
hpiMidwifery Council Register Number
  • oid: 2.16.840.1.113883.2.18.70.5
HISO
hpiNew Zealand Business NumberHISO
hpiNursing Council of New Zealand Register Number
  • oid: 2.16.840.1.113883.2.18.42
HISO
hpiOccupational Therapy Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.13
HISO
hpiOptometrists & Dispensing Opticians Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.12
HISO
hpiOsteopathic Council Register Number
  • oid: 2.16.840.1.113883.2.18.70.6
HISO
hpiPharmacy Council of New Zealand Register Number
  • oid: 2.16.840.1.113883.2.18.68
  • oid: 2.16.840.1.113883.2.18.9
HISO
hpiPhysiotherapyĆ’ Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.7
HISO
hpiPodiatrists Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.8
HISO
hpiPsychologists Board Register Number
  • oid: 2.16.840.1.113883.2.18.70.9
HISO
hpiPsychotherapists Board register Number
  • oid: 2.16.840.1.113883.2.18.70.7
HISO
nhiNHI number
  • uri: https://standards.digital.health.nz/id/nhi Deprecated
  • oid: 2.16.840.1.113883.2.18.2
HISO


Summary generated: Wed Nov 25 2020 15:32:38 GMT+1300 (New Zealand Daylight Time)