New Zealand HPI IG
0.2.0 - CI Build

New Zealand HPI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Resource Profile: HpiLocation

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/HpiLocation
Version:0.2.0
Name:HpiLocation
Title:HPI Location
Status:Active as of 2020-10-11T23:44:54+00:00
Definition:

Locations used by the HPI. These are also called Facilities.

Publisher:David Hay
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/HpiLocation

Formal Views of Profile Content

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

This structure is derived from CommonLocation

Summary

Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from CommonLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... location-established 0..1PeriodThe date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/location-established
... dhb 0..1CodeableConceptThe identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board HPI Organisation Identifer (preferred)
... operationalStatus 0..0
... alias
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... alias-type 1..1CodeableConceptThe type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Location alias types (preferred)
... mode 0..0
... type 0..*CodeableConceptType of function performed
Binding: Type of location (required)
... telecom
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address
.... use 0..1codehome | work | temp | old | billing - purpose of this address
Binding: Use values for an Address (required)
... physicalType 0..0
... position 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..*Reference(HPI Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... location-established 0..1PeriodThe date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/location-established
... dhb 0..1CodeableConceptThe identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board HPI Organisation Identifer (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantHpiFacId SΣ0..*IdentifierOld facility id's that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: Status of Location - is it still in use (required)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... alias-type 1..1CodeableConceptThe type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Location alias types (preferred)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: Type of location (required)
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address 0..1CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional 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..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: Use values for an Address (required)
Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... endpoint 0..*Reference(HPI Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... identifier:HpifacId Σ0..1IdentifierThe current Facility id for this location
... identifier:dormantHpiFacId Σ0..*IdentifierOld facility id's that have been deprecated
... identifier:MOHFacId Σ0..1IdentifierThe MOH (NZHIS) Legacy facility code)

doco Documentation for this format

This structure is derived from CommonLocation

Summary

Mandatory: 0 element (2 nested mandatory elements)
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CommonLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... location-established 0..1PeriodThe date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/location-established
... dhb 0..1CodeableConceptThe identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board HPI Organisation Identifer (preferred)
... operationalStatus 0..0
... alias
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... alias-type 1..1CodeableConceptThe type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Location alias types (preferred)
... mode 0..0
... type 0..*CodeableConceptType of function performed
Binding: Type of location (required)
... telecom
.... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address
.... use 0..1codehome | work | temp | old | billing - purpose of this address
Binding: Use values for an Address (required)
... physicalType 0..0
... position 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..*Reference(HPI Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... location-established 0..1PeriodThe date when this location first became available for use
URL: http://hl7.org.nz/fhir/StructureDefinition/location-established
... dhb 0..1CodeableConceptThe identifier for the DHB that is associated with this location
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board HPI Organisation Identifer (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantHpiFacId SΣ0..*IdentifierOld facility id's that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: Status of Location - is it still in use (required)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... alias-type 1..1CodeableConceptThe type of alias this is - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
..... value[x] 0..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Location alias types (preferred)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: Type of location (required)
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address 0..1CommonAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional 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..1stringThe suburb part of the address
URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
.... building-name 0..1stringThe name of the building
URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
.... domicile-code 0..1CodeableConceptThe domicile code associated with this address
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: domicileCode (preferred)
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: Use values for an Address (required)
Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... endpoint 0..*Reference(HPI Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.identifier:HpifacId.userequiredFixed Value: official
Location.identifier:HpifacId.typeextensibleIdentifier Type Codes
Location.identifier:dormantHpiFacId.userequiredFixed Value: old
Location.identifier:dormantHpiFacId.typeextensibleIdentifier Type Codes
Location.identifier:MOHFacId.userequiredFixed Value: official
Location.identifier:MOHFacId.typeextensibleIdentifier Type Codes
Location.statusrequiredLocationStatus
Location.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredLocationAliasType
Location.typerequiredLocationType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek