New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Resource Profile: HPI Location

Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPILocation Version: 1.5.0
Active as of 2024-12-17 Computable Name: HpiLocation

A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility.

The Location resource represents named Facilities at which an organisation provides health services

HPI Facilities each have an identifier in the format FXXNNN-C where X is alphanumeric, N is numeric and C is a check character

A facility can only be related to a single organisation (location.managingOrganization).

There can be many facilities at the same address – each related to a different organisation.

An organisation may have multiple facilities at the same address – each with a different purpose.

Usage:

Formal Views of Profile Content

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

This structure is derived from NzLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location NzLocation
... Slices for extension Content/Rules for all slices
.... extension:dhb 0..1 Dhb The identifier for the DHB that is associated with this location
.... extension:established 0..1 Established The date when this location first became available for use
.... extension:funded-programme 0..0
.... extension:pho 0..0
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... use 0..1 code official | old
Binding: IdentifierUse (required)
..... type 0..0
..... period 0..0
.... identifier:facId S 1..1 Identifier The current Facility id for this location
..... use 1..1 code fixed to official
Fixed Value: official
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant S 0..* Identifier Old facility id's that have been deprecated
..... use 1..1 code fixed to old
Fixed Value: old
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyFacId 0..1 Identifier The MOH (NZHIS) Legacy facility code)
..... use 1..1 code fixed to official
Fixed Value: official
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... status 0..1 code active | inactive
Binding: HPI Location Status (required)
... alias
.... Slices for extension Content/Rules for all slices
..... extension:alias-type 0..1 AliasType The type of alias this is - eg its Maori name
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
... mode 0..0
... type 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
... telecom
.... use 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... use 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
... physicalType 0..0
... position 0..0
... managingOrganization 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_location_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* NzLocation Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... dhb 0..1 CodeableConcept The identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
ele-1: All FHIR elements must have a @value or children
.... identifier:facId SΣ 1..1 Identifier The current Facility id for this location
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
.... identifier:dormant SΣ 0..* Identifier Old facility id's that have been deprecated
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: old
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
.... identifier:legacyFacId Σ 0..1 Identifier The MOH (NZHIS) Legacy facility code)
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | inactive
Binding: HPI Location Status (required)
ele-1: All FHIR elements must have a @value or children
... type Σ 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
ele-1: All FHIR elements must have a @value or children
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
ele-1: All FHIR elements must have a @value or children
Example General: home
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.identifier:facId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:legacyFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* NzLocation Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... dhb 0..1 CodeableConcept The identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs


.... established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:facId SΣ 1..1 Identifier The current Facility id for this location
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant SΣ 0..* Identifier Old facility id's that have been deprecated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyFacId Σ 0..1 Identifier The MOH (NZHIS) Legacy facility code)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... status ?!Σ 0..1 code active | inactive
Binding: HPI Location Status (required)
... name Σ 0..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... alias-type 0..1 (Complex) The type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
... telecom 0..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional 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..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
..... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
..... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... use ?!Σ 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street 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..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... managingOrganization Σ 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.identifier:facId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:facId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:dormant.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:legacyFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:legacyFacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_location_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

This structure is derived from NzLocation

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 2 elements
Fixed: 6 elements
Prohibited: 11 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 2 is sliced based on the values of Location.identifier

Differential View

This structure is derived from NzLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location NzLocation
... Slices for extension Content/Rules for all slices
.... extension:dhb 0..1 Dhb The identifier for the DHB that is associated with this location
.... extension:established 0..1 Established The date when this location first became available for use
.... extension:funded-programme 0..0
.... extension:pho 0..0
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... use 0..1 code official | old
Binding: IdentifierUse (required)
..... type 0..0
..... period 0..0
.... identifier:facId S 1..1 Identifier The current Facility id for this location
..... use 1..1 code fixed to official
Fixed Value: official
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant S 0..* Identifier Old facility id's that have been deprecated
..... use 1..1 code fixed to old
Fixed Value: old
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyFacId 0..1 Identifier The MOH (NZHIS) Legacy facility code)
..... use 1..1 code fixed to official
Fixed Value: official
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... status 0..1 code active | inactive
Binding: HPI Location Status (required)
... alias
.... Slices for extension Content/Rules for all slices
..... extension:alias-type 0..1 AliasType The type of alias this is - eg its Maori name
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
... mode 0..0
... type 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
... telecom
.... use 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... use 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
... physicalType 0..0
... position 0..0
... managingOrganization 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_location_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* NzLocation Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... dhb 0..1 CodeableConcept The identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
ele-1: All FHIR elements must have a @value or children
.... identifier:facId SΣ 1..1 Identifier The current Facility id for this location
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
.... identifier:dormant SΣ 0..* Identifier Old facility id's that have been deprecated
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: old
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
.... identifier:legacyFacId Σ 0..1 Identifier The MOH (NZHIS) Legacy facility code)
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 0..1 code active | inactive
Binding: HPI Location Status (required)
ele-1: All FHIR elements must have a @value or children
... type Σ 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
ele-1: All FHIR elements must have a @value or children
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
ele-1: All FHIR elements must have a @value or children
Example General: home
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
ele-1: All FHIR elements must have a @value or children
... managingOrganization Σ 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.identifier:facId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:legacyFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* NzLocation Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... dhb 0..1 CodeableConcept The identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs


.... established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
.... messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:facId SΣ 1..1 Identifier The current Facility id for this location
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant SΣ 0..* Identifier Old facility id's that have been deprecated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyFacId Σ 0..1 Identifier The MOH (NZHIS) Legacy facility code)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... status ?!Σ 0..1 code active | inactive
Binding: HPI Location Status (required)
... name Σ 0..1 string Name of the location as used by humans
... alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... alias-type 0..1 (Complex) The type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
... telecom 0..* ContactPoint Contact details of the location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address 0..1 NzAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional 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..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
..... building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
..... domicile-code 0..1 CodeableConcept The domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
.... use ?!Σ 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street 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..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ISO 3166-1:2013 (2-alpha country code) (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... managingOrganization Σ 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
... partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Location.identifier:facId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:facId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:dormant.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:legacyFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:legacyFacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredHpi_location_status
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Location.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_location_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code
Location.typerequiredHpi_location_type
https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Location.address.userequiredHpi_location_address_use
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.countryrequiredHpi_country_code_iso_3166_1
https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

This structure is derived from NzLocation

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 2 elements
Fixed: 6 elements
Prohibited: 11 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 2 is sliced based on the values of Location.identifier

 

Other representations of profile: CSV, Excel, Schematron