NHSD Implementation Guide - Outbound
4.0.1 - active
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:   |
|---|---|---|---|---|
  Location |
0..* | AUPDLocation | Australian location details | |
  id |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
  meta |
Σ | 1..1 | Meta | Metadata on Location |
  extension |
0..0 | |||
 lastUpdated |
Σ | 1..1 | instant | The time when the resource was last updated |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
  identifier:rid |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
Σ | 0..1 | string | Name of the location |
| mode |
Σ | 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 |
| type |
Σ | 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: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| address |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
| extension |
0..0 | |||
| physicalType |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
 managingOrganization |
Σ | 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 | Conformance | ValueSet / Code | URI |
| Location.identifier:nataSite.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.0From the FHIR Standard | |
| Location.mode | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/location-mode|4.0.0From the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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: |
|---|---|---|---|---|
| Location |
0..* | AUPDLocation | Australian location details | |
 id |
1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle | |
| meta |
1..1 | Meta | Metadata on Location | |
| id |
0..0 | |||
| extension |
0..0 | |||
| versionId |
0..0 | |||
| lastUpdated |
1..1 | instant | The time when the resource was last updated | |
| source |
0..0 | |||
| profile |
0..0 | |||
| security |
0..0 | |||
| tag |
0..0 | |||
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| text |
0..0 | |||
| contained |
0..0 | |||
| Slices for identifier |
0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by | |
 identifier:nataSite |
0..0 | |||
| identifier:rid |
S | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
1..1 | code | active | inactive | |
| operationalStatus |
0..0 | |||
| name |
0..1 | string | Name of the location | |
| alias |
0..0 | |||
| mode |
0..1 | code | instance | kind Fixed Value: instance | |
| type |
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. | |
| telecom |
0..0 | |||
| address |
1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided | |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
0..0 | |||
| type |
0..0 | |||
| text |
0..0 | |||
| line |
0..0 | |||
| city |
0..0 | |||
| district |
0..0 | |||
| state |
0..0 | |||
| postalCode |
0..0 | |||
| country |
0..0 | |||
| period |
0..0 | |||
| physicalType |
0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) | |
| position |
||||
| id |
0..0 | |||
| extension |
0..0 | |||
| modifierExtension |
0..0 | |||
| altitude |
0..0 | |||
| managingOrganization |
0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) | |
| partOf |
0..0 | |||
| hoursOfOperation |
0..0 | |||
| availabilityExceptions |
0..0 | |||
| endpoint |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Location |
0..* | AUPDLocation | Australian location details | |
| id |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
| meta |
Σ | 1..1 | Meta | Metadata on Location |
| extension |
0..0 | |||
| lastUpdated |
Σ | 1..1 | instant | The time when the resource was last updated |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
| identifier:rid |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
Σ | 0..1 | string | Name of the location |
| 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. Fixed Value: instance |
| type |
Σ | 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: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| address |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
| extension |
0..0 | |||
| physicalType |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
| position |
0..1 | BackboneElement | The absolute geographic location | |
| longitude |
1..1 | decimal | Longitude with WGS84 datum | |
| latitude |
1..1 | decimal | Latitude with WGS84 datum | |
| managingOrganization |
Σ | 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 | Conformance | ValueSet / Code | URI |
| Location.identifier:nataSite.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Location.identifier:nataSite.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.0From the FHIR Standard | |
| Location.mode | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/location-mode|4.0.0From the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG | |
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.0From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: |
|---|---|---|---|---|
| Location |
0..* | AUPDLocation | Australian location details | |
| id |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
| meta |
Σ | 1..1 | Meta | Metadata on Location |
| extension |
0..0 | |||
| lastUpdated |
Σ | 1..1 | instant | The time when the resource was last updated |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
| identifier:rid |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
Σ | 0..1 | string | Name of the location |
| mode |
Σ | 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 |
| type |
Σ | 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: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| address |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
| extension |
0..0 | |||
| physicalType |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
| managingOrganization |
Σ | 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 | Conformance | ValueSet / Code | URI |
| Location.identifier:nataSite.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.0From the FHIR Standard | |
| Location.mode | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/location-mode|4.0.0From the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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: |
|---|---|---|---|---|
| Location |
0..* | AUPDLocation | Australian location details | |
| id |
1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle | |
| meta |
1..1 | Meta | Metadata on Location | |
| id |
0..0 | |||
| extension |
0..0 | |||
| versionId |
0..0 | |||
| lastUpdated |
1..1 | instant | The time when the resource was last updated | |
| source |
0..0 | |||
| profile |
0..0 | |||
| security |
0..0 | |||
| tag |
0..0 | |||
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| text |
0..0 | |||
| contained |
0..0 | |||
| Slices for identifier |
0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by | |
| identifier:nataSite |
0..0 | |||
| identifier:rid |
S | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
1..1 | code | active | inactive | |
| operationalStatus |
0..0 | |||
| name |
0..1 | string | Name of the location | |
| alias |
0..0 | |||
| mode |
0..1 | code | instance | kind Fixed Value: instance | |
| type |
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. | |
| telecom |
0..0 | |||
| address |
1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided | |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
0..0 | |||
| type |
0..0 | |||
| text |
0..0 | |||
| line |
0..0 | |||
| city |
0..0 | |||
| district |
0..0 | |||
| state |
0..0 | |||
| postalCode |
0..0 | |||
| country |
0..0 | |||
| period |
0..0 | |||
| physicalType |
0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) | |
| position |
||||
| id |
0..0 | |||
| extension |
0..0 | |||
| modifierExtension |
0..0 | |||
| altitude |
0..0 | |||
| managingOrganization |
0..1 | Reference(NHSD Organisation) | This is a reference to service providing Organization (same as the organisation reference in the connected healthcare service resource) | |
| partOf |
0..0 | |||
| hoursOfOperation |
0..0 | |||
| availabilityExceptions |
0..0 | |||
| endpoint |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Location |
0..* | AUPDLocation | Australian location details | |
| id |
Σ | 1..1 | id | Logical FHIR id for unique identification of the location resource within the FHIR bundle |
| meta |
Σ | 1..1 | Meta | Metadata on Location |
| extension |
0..0 | |||
| lastUpdated |
Σ | 1..1 | instant | The time when the resource was last updated |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier, AULocationSpecificPracticeNumber | NHSD entry Location identifiers Slice: Unordered, Open by value:system |
| identifier:rid |
SΣ | 0..1 | NHSDResourceIdentifier | Unique code or number identifying the location to its users |
| status |
?!SΣ | 1..1 | code | active | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
Σ | 0..1 | string | Name of the location |
| 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. Fixed Value: instance |
| type |
Σ | 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: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| address |
S | 1..1 | NHSDAddress | Physical Address of the location where the Healthcare Service is provided |
| extension |
0..0 | |||
| physicalType |
Σ | 0..1 | CodeableConcept | Location definition of the Service HOME / VIRTUAL / PHYSICAL Binding: Location Type (required) |
| position |
0..1 | BackboneElement | The absolute geographic location | |
| longitude |
1..1 | decimal | Longitude with WGS84 datum | |
| latitude |
1..1 | decimal | Latitude with WGS84 datum | |
| managingOrganization |
Σ | 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 | Conformance | ValueSet / Code | URI |
| Location.identifier:nataSite.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.0From the FHIR Standard | |
| Location.identifier:nataSite.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.0From the FHIR Standard | |
| Location.mode | required | Fixed Value: instancehttp://hl7.org/fhir/ValueSet/location-mode|4.0.0From the FHIR Standard | |
| Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
| Location.physicalType | required | Location Typehttp://fhir.nhsd.com.au/ValueSet/valueset-au-location-physicalTypeFrom this IG | |
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.0From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
IG © 2022+ Healthdirect Australia. Package nhsd.org.au.r4#4.0.1 based on FHIR 4.0.1. Generated 2025-09-04
Links: Table of Contents |
QA Report
| Version History |
