New Zealand HPI IG
0.2.0 - CI Build

New Zealand HPI IG, published by David Hay. 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/hpi/ and changes regularly. See the Directory of published versions

Terminology

ValueSets

Valuesets are selectors of concepts (represented as codes) that are used to indicate preferred values for specific elements in a particular context. The codes are actually defined in a Code System. The profile is used to 'bind' the ValueSet to an element. A ValueSet can refer to concepts from multiple CodeSystems, and any concept can be references by many ValueSets. Ideally (and the case in this guide) the url of the valueSet will 'resolve' - entering it into a browser or REST client will return the ValueSet. A common pattern is to have a ValueSet that 'includes' all the codes from a code system.
ValueSetPurposeUrlCodeSystem Urls
District Health Board HPI Organisation IdentiferDistrict Health Board HPI Organisation Identiferhttps://standards.digital.health.nz/fhir/ValueSet/dhb-code
Type of Payload in an EndpointType of Payload in an Endpointhttps://standards.digital.health.nz/fhir/ValueSet/endpoint-payload-type-code
Use values for an AddressUse values for an Addresshttps://standards.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Use values for a ContactPointUse values for a ContactPointhttps://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Use values for a HumanNameUse values for a HumanNamehttps://standards.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Use values for an identifierUse values for an identifierhttps://standards.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
PractitonerRole status reasonThe reason for the current status of PractitionerRolehttps://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
Location alias typesThe set of alias types that apply to Locationshttps://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code
Status of Location - is it still in useStatus of Location - is it still in usehttps://standards.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Type of locationType of Locationhttps://standards.digital.health.nz/fhir/ValueSet/location-type-code
Organization alias typesThe set of alias types that apply to Organizationshttps://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Additional Authorisation for functions that a Practitioner can performA coded type for additional authorisationshttps://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
Professional registration the healthcare provider hasProfessional registration the healthcare provider hashttps://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Registration Status of PractitionersThe code list represents the current practicing status of the Provider Person as per their registration with an RA.https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
Scope of practiceA coded type for professional scope of practice.https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code
PractitionerRoleCodesCoded roles that can be in a PractitionerRolehttps://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code



ValueSet by path

Coded bindings - even for terminology defined elsewhere

PathValueSetNotes
Endpoint.payloadType https://standards.digital.health.nz/fhir/ValueSet/endpoint-payload-type-code
Location.status https://standards.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.alias.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code
Location.type https://standards.digital.health.nz/fhir/ValueSet/location-type-code
Location.telecom.use https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Location.address.use https://standards.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Organization.alias.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Organization.telecom.use https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Practitioner.identifier.system https://standards.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Practitioner.name.use https://standards.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
Practitioner.qualification.code https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
PractitionerRole.identifier.system https://standards.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
PractitionerRole.code https://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitionerRole.telecom.use https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Extension.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
Extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/dhb-code
Extension.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
Extension.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
Extension.extension.valueCodeableConcept https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code



CodeSystems

These are codesystems that have been defined by this guide. They define specific concepts that are included in ValueSets. It is preferabe to use an international code systm such as SNOMED, ICD or LOINC - but this is not always possible.

Each CodeSystem has a globally unique url that is used to unambiguously identiy it. The url generally refers to a describtion of the codesystem, rather than to the FHIR CodeSystem resource.

The FHIR spec has much more detail on the use of Terminology in FHIR

CodeSystemPurposeCodeSystem Url
Type of AliasUsed in Organization and Location to indicate what is the type of Aliashttps://standards.digital.health.nz/ns/alias-type-code
District Health Board CodeDistrict Health Board Codehttps://standards.digital.health.nz/ns/dhb-code
Type of Payload in an EndpointType of Payload in an Endpointhttps://standards.digital.health.nz/ns/endpoint-payload-type-code
PractitonerRole status reasonThe reason for the current status of PractitionerRolehttps://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code
Type of LocationType of Locationhttps://standards.digital.health.nz/ns/location-type-code
Additional AuthorisationAdditional authorisations that a practitioner is authorised to practice or prescribe.https://standards.digital.health.nz/ns/practitioner-additional-authorization-code
Professional registration the healthcare provider hasProfessional registration the healthcare provider hashttps://standards.digital.health.nz/ns/practitioner-registration-authority-code
Registration Status of PractitionersThe code list represents the current practicing status of the Provider Person as per their registration with an RA.https://standards.digital.health.nz/ns/practitioner-registration-status-code
PractitionerRoleCodesCoded roles that can be in a PractitionerRolehttps://standards.digital.health.nz/ns/practitioner-role-code
Scope of practiceA 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.https://standards.digital.health.nz/ns/practitioner-scope-of-practice-code