NHSD Implementation Guide - Outbound
4.0.1 - active
NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-location | Version: 4.0.1 | |||
| Draft as of 2023-09-14 | Computable Name: NHSDLocation | |||
Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
A National Health Services Directory (NHSD) Location
An extended resource providing additional information on the Location not offered by the AU-BASE.
The NHSD Location provides physical address information for HealthcareService. The Location also provides context for the type of address (through physicalType) where a HealthcareService is provided as Home Services (the Medical Practitioner comes to your home) or Virtual Services (Phone, Website).
The NHSD FHIR Server does not support searching the Location resource individually - it requires context of a HealthcareService. Please refer to NHSD HealthcareService
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Location |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The time when the resource was last updated |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
Σ | 0..1 | string | Name of the location |
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
![]() ![]() |
Σ | 0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
![]() ![]() |
Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.identifier:nataSite.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.status | Base | required | LocationStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.mode | Base | required | LocationMode | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.type | Base | extensible | V3 Value SetServiceDeliveryLocationRoleType | 📦2014-03-26 | FHIR Std. |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Location | A resource should have narrative for robust management |
text.div.exists()
|
This structure is derived from AUPDLocation
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle | |
![]() ![]() |
1..1 | Meta | Metadata on Location | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Version specific identifier | ||
![]() ![]() ![]() |
1..1 | instant | The time when the resource was last updated | |
![]() ![]() ![]() |
0..0 | Identifies where the resource comes from | ||
![]() ![]() ![]() |
0..0 | Profiles this resource claims to conform to | ||
![]() ![]() ![]() |
0..0 | Security Labels applied to this resource | ||
![]() ![]() ![]() |
0..0 | Tags applied to this resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by | |
![]() ![]() ![]() |
0..0 | National Association of Testing Authorities (NATA) Site Number | ||
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
1..1 | code | active | inactive | |
![]() ![]() |
0..0 | The operational status of the location (typically only for a bed/room) | ||
![]() ![]() |
0..1 | string | Name of the location | |
![]() ![]() |
0..0 | A list of alternate names that the location is known as, or was known as, in the past | ||
![]() ![]() |
0..1 | code | instance | kind Fixed Value: instance | |
![]() ![]() |
0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. | |
![]() ![]() |
0..0 | Contact details of the location | ||
![]() ![]() |
1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | home | work | temp | old | billing - purpose of this address | ||
![]() ![]() ![]() |
0..0 | postal | physical | both | ||
![]() ![]() ![]() |
0..0 | Text representation of the address | ||
![]() ![]() ![]() |
0..0 | Street name, number, direction & P.O. Box etc. | ||
![]() ![]() ![]() |
0..0 | Name of city, town etc. | ||
![]() ![]() ![]() |
0..0 | District name (aka county) | ||
![]() ![]() ![]() |
0..0 | Sub-unit of country (abbreviations ok) | ||
![]() ![]() ![]() |
0..0 | Postal code for area | ||
![]() ![]() ![]() |
0..0 | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
![]() ![]() ![]() |
0..0 | Time period when address was/is in use | ||
![]() ![]() |
0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Altitude with WGS84 datum | ||
![]() ![]() |
0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) | |
![]() ![]() |
0..0 | Another Location this one is physically a part of | ||
![]() ![]() |
0..0 | What days/times during a week is this location usually open | ||
![]() ![]() |
0..0 | Description of availability exceptions | ||
![]() ![]() |
0..0 | Technical endpoints providing access to services operated for the location | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Location |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The time when the resource was last updated |
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
Σ | 0..1 | string | Name of the location |
![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
![]() ![]() |
Σ | 0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() |
Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.identifier:nataSite.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.identifier:nataSite.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Location.status | Base | required | LocationStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.mode | Base | required | LocationMode | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.type | Base | extensible | V3 Value SetServiceDeliveryLocationRoleType | 📦2014-03-26 | FHIR Std. |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
| Location.hoursOfOperation.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Location | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
This structure is derived from AUPDLocation
Summary
Mandatory: 4 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Location |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The time when the resource was last updated |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
Σ | 0..1 | string | Name of the location |
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
![]() ![]() |
Σ | 0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
![]() ![]() |
Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.identifier:nataSite.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.status | Base | required | LocationStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.mode | Base | required | LocationMode | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.type | Base | extensible | V3 Value SetServiceDeliveryLocationRoleType | 📦2014-03-26 | FHIR Std. |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Location | A resource should have narrative for robust management |
text.div.exists()
|
Differential View
This structure is derived from AUPDLocation
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle | |
![]() ![]() |
1..1 | Meta | Metadata on Location | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Version specific identifier | ||
![]() ![]() ![]() |
1..1 | instant | The time when the resource was last updated | |
![]() ![]() ![]() |
0..0 | Identifies where the resource comes from | ||
![]() ![]() ![]() |
0..0 | Profiles this resource claims to conform to | ||
![]() ![]() ![]() |
0..0 | Security Labels applied to this resource | ||
![]() ![]() ![]() |
0..0 | Tags applied to this resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by | |
![]() ![]() ![]() |
0..0 | National Association of Testing Authorities (NATA) Site Number | ||
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
1..1 | code | active | inactive | |
![]() ![]() |
0..0 | The operational status of the location (typically only for a bed/room) | ||
![]() ![]() |
0..1 | string | Name of the location | |
![]() ![]() |
0..0 | A list of alternate names that the location is known as, or was known as, in the past | ||
![]() ![]() |
0..1 | code | instance | kind Fixed Value: instance | |
![]() ![]() |
0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. | |
![]() ![]() |
0..0 | Contact details of the location | ||
![]() ![]() |
1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | home | work | temp | old | billing - purpose of this address | ||
![]() ![]() ![]() |
0..0 | postal | physical | both | ||
![]() ![]() ![]() |
0..0 | Text representation of the address | ||
![]() ![]() ![]() |
0..0 | Street name, number, direction & P.O. Box etc. | ||
![]() ![]() ![]() |
0..0 | Name of city, town etc. | ||
![]() ![]() ![]() |
0..0 | District name (aka county) | ||
![]() ![]() ![]() |
0..0 | Sub-unit of country (abbreviations ok) | ||
![]() ![]() ![]() |
0..0 | Postal code for area | ||
![]() ![]() ![]() |
0..0 | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
![]() ![]() ![]() |
0..0 | Time period when address was/is in use | ||
![]() ![]() |
0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Altitude with WGS84 datum | ||
![]() ![]() |
0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) | |
![]() ![]() |
0..0 | Another Location this one is physically a part of | ||
![]() ![]() |
0..0 | What days/times during a week is this location usually open | ||
![]() ![]() |
0..0 | Description of availability exceptions | ||
![]() ![]() |
0..0 | Technical endpoints providing access to services operated for the location | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDLocation | Australian location details | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Location |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The time when the resource was last updated |
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
Σ | 0..1 | string | Name of the location |
![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. Fixed Value: instance |
![]() ![]() |
Σ | 0..* | CodeableConcept | Type of role - NHSD defaults this to WORK for physical location. NHSD maps all MOBL locations as home visit location regardless of further granularity of a mobile location. Binding: V3 Value SetServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() |
Σ | 0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.identifier:nataSite.use | Base | required | IdentifierUse | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.identifier:nataSite.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Location.status | Base | required | LocationStatus | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.mode | Base | required | LocationMode | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Location.type | Base | extensible | V3 Value SetServiceDeliveryLocationRoleType | 📦2014-03-26 | FHIR Std. |
| Location.physicalType | Base | required | Location Type | 📦4.0.1 | This IG |
| Location.hoursOfOperation.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 → 4.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Location | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
This structure is derived from AUPDLocation
Summary
Mandatory: 4 elements
Must-Support: 1 element
Fixed: 1 element
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
The NHSD FHIR Server does not support complete search behaviours on the Location resource.
All search behaviours on the location is on chained support through HealthcareService and PractitionerRole.
Read: Location
Read identified location resource content.
GET [base]/Location/[id]
Example:
GET [base]/Location/bf379d2b-4546-451d-8e1b-fa34ea7ce60e
Support GET with references VIA search
GET [base]/Location?_id=[id]
Example:
GET [base]/Location?_id=9680fa57-554e-68a1-839a-63d44e501802
Search: Location
Search locations managed by an organization using the organisation id.
NHSD FHIR API supports only search location by the managing organization Id . It does not support searching location by any other attributes.
GET [base]/Location?organization=[organizationId]
Example:
GET [base]/Location?organization=b3693cd9-56ec-efe2-cbe7-5056099f0d1a
Healthcare Service and Location Types:
The NHSD FHIR Server contains three distinct types of Healthcare Services, relating to both the Location and the Healthcare Service delivery type.
| Location Delivery Type | Code | Description | Parameter |
|---|---|---|---|
| Area | area | Defines an area or coverage, primarily utilised within the context of a HealthcareService to specify the coverageArea. Coverage is defined in Suburb(s) OR State(s) OR Country (AUS) | n/a |
| Physical Service | si | A Physical location, where the patient is able to visit a room or building | location.physicalType=si |
| Home Visit | home | A Home Visit based location grouping, where all the Healthcare Services linked to this Location are considered HOME VISIT services. These are predominantly services such as Home Meal Services, Home Doctor Services, but not strictly limited thereto. Distance based search behaviours are not compatible with this Location Delivery Type | location.physicalType=home |
| Virtual | virtual | A Virtual or Online based location grouping, where all the Healthcare Services linked to this Location are considered VIRTUAL services. These may include, but not limited to websites, online help lines, emergency services, etc. Distance based search behaviours are not compatible with this Location Delivery Type | location.physicalType=virtual |
Search: Location Delivery Method
- SITE VISIT => [base]/HealthcareService?location.physicalType=si
- PHONE/VIRTUAL => [base]/HealthcareService?location.physicalType=virtual
- HOME => [base]/HealthcareService?location.physicalType=home