New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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 2026-11-08 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension: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
Location.Slices for extension.extension:established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.Slices for identifier This element is included in summaries. 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:facId This element must be supported. This element is included in summaries. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId This element is included in summaries. 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.address 0..1 NzAddress Physical location
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Location.address.Slices for extension.extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Location.address.Slices for extension.extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Location.address.Slices for extension.extension: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)
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
Location.address.country This element is included in summaries. 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)
Location.managingOrganization This element is included in summaries. 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.identifier:facId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

This structure is derived from NzLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:dhb 0..1 Dhb The identifier for the DHB that is associated with this location
Location.Slices for extension.extension:established 0..1 Established The date when this location first became available for use
Location.Slices for extension.extension:funded-programme 0..0 Funded Healthcare Programme
Location.Slices for extension.extension:pho 0..0 Primary Healthcare Organisation
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.use 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:All Slices.type 0..0 Description of identifier
Location.Slices for identifier.identifier:All Slices.period 0..0 Time period when id is/was valid for use
Location.Slices for identifier.identifier:facId This element must be supported. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.use 1..1 code fixed to old
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.alias
Location.alias.Slices for extension Content/Rules for all slices
Location.alias.Slices for extension.extension:alias-type 0..1 AliasType The type of alias this is - eg its Maori name
Location.alias.Slices for extension.extension:alias-type.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
Location.mode 0..0 instance | kind
Location.type 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.telecom
Location.telecom.use 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
Location.address 0..1 NzAddress Physical location
Location.address.use 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Location.address.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)
Location.physicalType 0..0 Physical form of the location
Location.position 0..0 The absolute geographic location
Location.managingOrganization 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..0 What days/times during a week is this location usually open
Location.availabilityExceptions 0..0 Description of availability exceptions
Location.endpoint 0..0 Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.alias.extension:alias-type.​valueCodeableConcept Base preferred HPI Alias Type (Location) 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.telecom.use Base required Use values for a ContactPoint 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Location.contained 0..* Resource Contained, inline Resources
Location.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.Slices for extension.extension: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
Location.Slices for extension.extension:established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.Slices for identifier This element is included in summaries. 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:facId This element must be supported. This element is included in summaries. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:facId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:facId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:facId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:facId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:facId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:dormant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:dormant.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId This element is included in summaries. 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:legacyFacId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:legacyFacId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:legacyFacId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:legacyFacId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:legacyFacId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.name This element is included in summaries. 0..1 string Name of the location as used by humans
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.alias.id 0..1 string xml:id (or equivalent in JSON)
Location.alias.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type 0..1 (Complex) The type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
Location.alias.Slices for extension.extension:alias-type.id 0..1 string Unique id for inter-element referencing
Location.alias.Slices for extension.extension:alias-type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Location.alias.Slices for extension.extension:alias-type.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Location.alias.Slices for extension.extension:alias-type.Slices for value[x] Content/Rules for all slices
Location.alias.Slices for extension.extension:alias-type.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
Location.alias.value 0..1 string Primitive value for string
Max Length:1048576
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.telecom 0..* ContactPoint Contact details of the location
Location.telecom.id 0..1 string Unique id for inter-element referencing
Location.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Location.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Location.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
Location.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Location.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Location.address 0..1 NzAddress Physical location
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.Slices for extension.extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Location.address.Slices for extension.extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Location.address.Slices for extension.extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Location.address.Slices for extension.extension: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)
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element is included in summaries. 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
Location.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Location.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Location.address.country This element is included in summaries. 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)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.managingOrganization This element is included in summaries. 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.identifier:facId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:facId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:dormant.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.alias.extension:alias-type.​value[x]:valueCodeableConcept Base preferred HPI Alias Type (Location) 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required Use values for a ContactPoint 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension: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
Location.Slices for extension.extension:established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.Slices for identifier This element is included in summaries. 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:facId This element must be supported. This element is included in summaries. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId This element is included in summaries. 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.address 0..1 NzAddress Physical location
Location.address.Slices for extension Content/Rules for all slices
Location.address.Slices for extension.extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Location.address.Slices for extension.extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Location.address.Slices for extension.extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Location.address.Slices for extension.extension: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)
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
Location.address.country This element is included in summaries. 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)
Location.managingOrganization This element is included in summaries. 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.identifier:facId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from NzLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:dhb 0..1 Dhb The identifier for the DHB that is associated with this location
Location.Slices for extension.extension:established 0..1 Established The date when this location first became available for use
Location.Slices for extension.extension:funded-programme 0..0 Funded Healthcare Programme
Location.Slices for extension.extension:pho 0..0 Primary Healthcare Organisation
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.use 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:All Slices.type 0..0 Description of identifier
Location.Slices for identifier.identifier:All Slices.period 0..0 Time period when id is/was valid for use
Location.Slices for identifier.identifier:facId This element must be supported. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.use 1..1 code fixed to old
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.use 1..1 code fixed to official
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.operationalStatus 0..0 The operational status of the location (typically only for a bed/room)
Location.alias
Location.alias.Slices for extension Content/Rules for all slices
Location.alias.Slices for extension.extension:alias-type 0..1 AliasType The type of alias this is - eg its Maori name
Location.alias.Slices for extension.extension:alias-type.valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
Location.mode 0..0 instance | kind
Location.type 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.telecom
Location.telecom.use 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
Location.address 0..1 NzAddress Physical location
Location.address.use 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Location.address.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)
Location.physicalType 0..0 Physical form of the location
Location.position 0..0 The absolute geographic location
Location.managingOrganization 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..0 What days/times during a week is this location usually open
Location.availabilityExceptions 0..0 Description of availability exceptions
Location.endpoint 0..0 Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.alias.extension:alias-type.​valueCodeableConcept Base preferred HPI Alias Type (Location) 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.telecom.use Base required Use values for a ContactPoint 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* NzLocation Details and position information for a physical place
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Location.contained 0..* Resource Contained, inline Resources
Location.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.Slices for extension.extension: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
Location.Slices for extension.extension:established 0..1 Period The date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:messaging-address 0..1 (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.Slices for identifier This element is included in summaries. 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for identifier.identifier:All Slices Content/Rules for all slices
Location.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code official | old
Binding: IdentifierUse (required)
Location.Slices for identifier.identifier:All Slices.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Location.Slices for identifier.identifier:All Slices.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:facId This element must be supported. This element is included in summaries. 1..1 Identifier The current Facility id for this location
Location.Slices for identifier.identifier:facId.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:facId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:facId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:facId.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:facId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:facId.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:facId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:facId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:dormant This element must be supported. This element is included in summaries. 0..* Identifier Old facility id's that have been deprecated
Location.Slices for identifier.identifier:dormant.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:dormant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:dormant.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: old (no extensions allowed)
Location.Slices for identifier.identifier:dormant.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:dormant.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:dormant.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:dormant.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:dormant.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.Slices for identifier.identifier:legacyFacId This element is included in summaries. 0..1 Identifier The MOH (NZHIS) Legacy facility code)
Location.Slices for identifier.identifier:legacyFacId.id 0..1 string Unique id for inter-element referencing
Location.Slices for identifier.identifier:legacyFacId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.Slices for identifier.identifier:legacyFacId.use This element is a modifier element. This element is included in summaries. 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: official (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.type This element is included in summaries. 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.
Location.Slices for identifier.identifier:legacyFacId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id (no extensions allowed)
Location.Slices for identifier.identifier:legacyFacId.value This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Location.Slices for identifier.identifier:legacyFacId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Location.Slices for identifier.identifier:legacyFacId.assigner This element is included in summaries. 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive
Binding: HPI Location Status (required)
Location.name This element is included in summaries. 0..1 string Name of the location as used by humans
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.alias.id 0..1 string xml:id (or equivalent in JSON)
Location.alias.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type 0..1 (Complex) The type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
Location.alias.Slices for extension.extension:alias-type.id 0..1 string Unique id for inter-element referencing
Location.alias.Slices for extension.extension:alias-type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type.url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Location.alias.Slices for extension.extension:alias-type.Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
Location.alias.Slices for extension.extension:alias-type.Slices for value[x] Content/Rules for all slices
Location.alias.Slices for extension.extension:alias-type.Slices for value[x].value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Location) (preferred)
Location.alias.value 0..1 string Primitive value for string
Max Length:1048576
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
Binding: HPI Location Type (required)
Location.telecom 0..* ContactPoint Contact details of the location
Location.telecom.id 0..1 string Unique id for inter-element referencing
Location.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.telecom.system This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Location.telecom.value This element is included in summaries. 0..1 string The actual contact point details
Location.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code work | temp - purpose of this contact point
Binding: Use values for a ContactPoint (required)
Location.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Location.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Location.address 0..1 NzAddress Physical location
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.Slices for extension.extension:nz-geocode 0..1 (Complex) A geocode using the NZ specific datum (reference point)
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Location.address.Slices for extension.extension:suburb 0..1 string The suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
Location.address.Slices for extension.extension:building-name 0..1 string The name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
Location.address.Slices for extension.extension: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)
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code work | old - purpose of this address
Binding: Address Use for Location (required)
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element is included in summaries. 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
Location.address.city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Location.address.postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Location.address.country This element is included in summaries. 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)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.managingOrganization This element is included in summaries. 0..1 Reference(HPI Organization) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(HPI Location) Another Location this one is physically a part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.identifier.​use Base required IdentifierUse 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.identifier:facId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:facId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:dormant.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:dormant.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:legacyFacId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required HPI Location Status 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.alias.extension:alias-type.​value[x]:valueCodeableConcept Base preferred HPI Alias Type (Location) 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.type Base required HPI Location Type 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Location.telecom.use Base required Use values for a ContactPoint 📦1.0 HIP FHIR Common Terminology Guide v1.9
Location.address.use Base required Address Use for Location 📦2.0 HIP FHIR Common Terminology Guide v1.9
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.country Base required ISO 3166-1:2013 (2-alpha country code) 📦2013 HIP FHIR Common Terminology Guide v1.9
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

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