New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org.nz/fhir/StructureDefinition/HPILocation |
Version: | 0.9.0 |
Name: | HpiLocation |
Title: | HPI Location |
Status: | Active as of 12/3/21, 2:22 AM |
Definition: | A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility. |
Publisher: | Ministry of Health |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/StructureDefinition/HPILocation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 6 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system | |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | official | old Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | The current Facility id for this location |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to official Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id | |
![]() ![]() ![]() ![]() | S | 0..* | Identifier | Old facility id's that have been deprecated |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to old Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The MOH (NZHIS) Legacy facility code) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to official Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Binding: HPI Alias Type (Location) (preferred) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | CodeableConcept | Type of function performed Binding: HPI Location Type (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() ![]() | 0..1 | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Address Use for Location (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | official | old Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Identifier | The current Facility id for this location |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣ | 0..* | Identifier | Old facility id's that have been deprecated |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | The MOH (NZHIS) Legacy facility code) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Binding: HPI Alias Type (Location) (preferred) | |
![]() ![]() ![]() ![]() | 0..1 | string | Primitive value for string Max Length: 1048576 | |
![]() ![]() ![]() | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of function performed Binding: HPI Location Type (required) |
![]() ![]() ![]() | 0..* | ContactPoint | Contact details of the location | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | 0..1 | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: domicileCode (preferred) | |
![]() ![]() ![]() ![]() | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Address Use for Location (required) Example General: home |
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 1..1 | Identifier | The current Facility id for this location |
![]() ![]() ![]() | Σ | 0..* | Identifier | Old facility id's that have been deprecated |
![]() |
This structure is derived from Location
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 6 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system | |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | official | old Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() | S | 1..1 | Identifier | The current Facility id for this location |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to official Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id | |
![]() ![]() ![]() ![]() | S | 0..* | Identifier | Old facility id's that have been deprecated |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to old Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The MOH (NZHIS) Legacy facility code) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | fixed to official Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Binding: HPI Alias Type (Location) (preferred) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | CodeableConcept | Type of function performed Binding: HPI Location Type (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) | |
![]() ![]() ![]() | 0..1 | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Address Use for Location (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Period | The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | official | old Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Identifier | The current Facility id for this location |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | SΣ | 0..* | Identifier | Old facility id's that have been deprecated |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | The MOH (NZHIS) Legacy facility code) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
![]() ![]() ![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Value of extension Binding: HPI Alias Type (Location) (preferred) | |
![]() ![]() ![]() ![]() | 0..1 | string | Primitive value for string Max Length: 1048576 | |
![]() ![]() ![]() | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of function performed Binding: HPI Location Type (required) |
![]() ![]() ![]() | 0..* | ContactPoint | Contact details of the location | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | string | EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | 0..1 | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode | |
![]() ![]() ![]() ![]() | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: domicileCode (preferred) | |
![]() ![]() ![]() ![]() | 0..1 | string | The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: Address Use for Location (required) Example General: home |
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
Location.identifier.use | required | Hpi_IdentfierUse |
Location.identifier.type | extensible | Identifier Type Codes |
Location.identifier:facId.use | required | Fixed Value: official |
Location.identifier:facId.type | extensible | Identifier Type Codes |
Location.identifier:dormant.use | required | Fixed Value: old |
Location.identifier:dormant.type | extensible | Identifier Type Codes |
Location.identifier:legacyFacId.use | required | Fixed Value: official |
Location.identifier:legacyFacId.type | extensible | Identifier Type Codes |
Location.status | required | LocationStatus |
Location.alias.extension:alias-type.value[x]:valueCodeableConcept | preferred | Hpi_location_alias_type |
Location.type | required | Hpi_location_type |
Location.telecom.system | required | ContactPointSystem |
Location.telecom.use | required | Hpi_ContactPointUse |
Location.address.use | required | Hpi_location_address_use |
Location.address.type | required | AddressType |
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |