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
This structure is derived from CommonLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | CommonLocation | Details and position information for a physical place | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 location-established | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/location-established | |
| 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 HPI Organisation Identifer (preferred) | |
 status | 0..1 | code | active | suspended | inactive Binding: Status of Location - is it still in use (required) | |
| operationalStatus | 0..0 | |||
 alias | ||||
 extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 alias-type | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type | |
  valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Location alias types (preferred) | |
| mode | 0..0 | |||
| type | 0..* | CodeableConcept | Type of function performed Binding: Type of location (required) | |
| telecom | ||||
 use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| address | ||||
| use | 0..1 | code | home | 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | CommonLocation | Details and position information for a physical place | |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| location-established | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/location-established | |
| 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 HPI Organisation Identifer (preferred) | |
 modifierExtension | ?! | 0..* | Extension | Extensions 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..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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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(Organization) | Organization that issued id (may be just text) |
| identifier:dormantHpiFacId | 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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: old |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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(Organization) | Organization that issued id (may be just text) |
 identifier:MOHFacId | SΣ | 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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-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(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: Status of Location - is it still in use (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) | |
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| alias-type | 1..1 | CodeableConcept | 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" | |
 value[x] | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
 value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Location alias types (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: Type of location (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 | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - 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 | CommonAddress | 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 | |
| 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: domicileCode (preferred) | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Use values for an Address (required) Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) 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) |
| 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(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | CommonLocation | Details and position information for a physical place | |
| identifier:HpifacId | Σ | 0..1 | Identifier | The current Facility id for this location |
| identifier:dormantHpiFacId | Σ | 0..* | Identifier | Old facility id's that have been deprecated |
| identifier:MOHFacId | Σ | 0..1 | Identifier | The MOH (NZHIS) Legacy facility code) |
| Documentation for this format | ||||
This structure is derived from CommonLocation
Differential View
This structure is derived from CommonLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | CommonLocation | Details and position information for a physical place | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| location-established | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/location-established | |
| 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 HPI Organisation Identifer (preferred) | |
| status | 0..1 | code | active | suspended | inactive Binding: Status of Location - is it still in use (required) | |
| operationalStatus | 0..0 | |||
| alias | ||||
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| alias-type | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type | |
| valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Location alias types (preferred) | |
| mode | 0..0 | |||
| type | 0..* | CodeableConcept | Type of function performed Binding: Type of location (required) | |
| telecom | ||||
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
| address | ||||
| use | 0..1 | code | home | 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 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | CommonLocation | Details and position information for a physical place | |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| location-established | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/location-established | |
| 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 HPI Organisation Identifer (preferred) | |
| modifierExtension | ?! | 0..* | Extension | Extensions 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..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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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(Organization) | Organization that issued id (may be just text) |
| identifier:dormantHpiFacId | 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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: old |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| 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(Organization) | Organization that issued id (may be just text) |
| identifier:MOHFacId | SΣ | 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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) Fixed Value: official |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-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(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: Status of Location - is it still in use (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) | |
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| alias-type | 1..1 | CodeableConcept | 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" | |
| value[x] | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Location alias types (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: Type of location (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 | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - 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 | CommonAddress | 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 | |
| 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: domicileCode (preferred) | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Use values for an Address (required) Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) 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) |
| 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(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(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 | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Location.identifier:HpifacId.use | required | Fixed Value: official |
| Location.identifier:HpifacId.type | extensible | Identifier Type Codes |
| Location.identifier:dormantHpiFacId.use | required | Fixed Value: old |
| Location.identifier:dormantHpiFacId.type | extensible | Identifier Type Codes |
| Location.identifier:MOHFacId.use | required | Fixed Value: official |
| Location.identifier:MOHFacId.type | extensible | Identifier Type Codes |
| Location.status | required | LocationStatus |
| Location.alias.extension:alias-type.value[x]:valueCodeableConcept | preferred | LocationAliasType |
| Location.type | required | LocationType |
| Location.telecom.system | required | ContactPointSystem |
| Location.telecom.use | required | ContactPointUse |
| Location.address.use | required | AddressUse |
| Location.address.type | required | AddressType |
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |