HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release
HL7® FHIR® New Zealand Base Implementation Guide
3.0.0 - Release
HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzLocation | Version: 1.0.0 | |||
| Draft as of 2023-12-04 |
Realm: 
|
Computable Name: NzLocation | ||
Location resource for use in NZ
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | Location | Details and position information for a physical place | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |
| established | 0..1 | Period | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
| funded-programme | 0..1 | (Complex) | Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme | |
| pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.status | required | LocationStatus |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |||||
| established | 0..1 | Period | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established | |||||
| funded-programme | 0..1 | (Complex) | Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme | |||||
| pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |||||
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans | ||||
 alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| alias-type | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: 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 | ||||
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | 0..1 | Address | Physical location | |||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
| position | 0..1 | BackboneElement | The absolute geographic location | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
 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 | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | The Location is open all day | |||||
| openingTime | 0..1 | time | Time that the Location opens | |||||
| closingTime | 0..1 | time | Time that the Location closes | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from Location
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Location
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |
| established | 0..1 | Period | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established | |
| funded-programme | 0..1 | (Complex) | Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme | |
| pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.status | required | LocationStatus |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a physical place | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dhb | 0..1 | CodeableConcept | District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs | |||||
| established | 0..1 | Period | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established | |||||
| funded-programme | 0..1 | (Complex) | Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme | |||||
| pho | 0..1 | CodeableConcept | Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs | |||||
| messaging-address | 0..* | (Complex) | Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name | Σ | 0..1 | string | Name of the location as used by humans | ||||
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| alias-type | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: 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 | ||||
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
| telecom | 0..* | ContactPoint | Contact details of the location | |||||
| address | 0..1 | Address | Physical location | |||||
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
| position | 0..1 | BackboneElement | The absolute geographic location | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
| 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 | |||||
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | The Location is open all day | |||||
| openingTime | 0..1 | time | Time that the Location opens | |||||
| closingTime | 0..1 | time | Time that the Location closes | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from Location
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
