Australian Digital Health Agency FHIR
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-location-core-1 | Version: 1.0.0 | |||
Active as of 2024-09-16 | Computable Name: ADHALocationCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to provide a core representation of a location for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
In the context of an exchange of health information a location is part of the context established for a set of healthcare-related information.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Location that are supported.
A Location resource is used within the context of a referencing resource.
This profile is designed to set a core Location standard for:
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display |
managingOrganization | SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep |
partOf | SC | 0..1 | Reference(ADHA Core Location) | Another Location this one is physically a part of |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | SOC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | 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. | ||||||
name | SOΣ | 0..1 | string | Name of the location as used by humans
| ||||||
mode | SOΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
| ||||||
type | SOΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
| ||||||
address | SOC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||
physicalType | SOΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
| ||||||
managingOrganization | SOΣC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep
| ||||||
partOf | SC | 0..1 | Reference(ADHA Core Location) | Another Location this one is physically a part of | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | |
Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display | ||||||
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 | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | SOC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | 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 | SOΣ | 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 | |||||||
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||||
mode | SOΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
| ||||||
type | SOΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
| ||||||
telecom | 0..* | ContactPoint | Contact details of the location | |||||||
address | SOC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||
physicalType | SOΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
| ||||||
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 | SOΣC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep
| ||||||
partOf | SC | 0..1 | Reference(ADHA Core 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 | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | ||||
Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUCoreLocation
Differential View
This structure is derived from AUCoreLocation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display |
managingOrganization | SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep |
partOf | SC | 0..1 | Reference(ADHA Core Location) | Another Location this one is physically a part of |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | SOC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | 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. | ||||||
name | SOΣ | 0..1 | string | Name of the location as used by humans
| ||||||
mode | SOΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
| ||||||
type | SOΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
| ||||||
address | SOC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||
physicalType | SOΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
| ||||||
managingOrganization | SOΣC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep
| ||||||
partOf | SC | 0..1 | Reference(ADHA Core Location) | Another Location this one is physically a part of | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | |
Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Location | C | 0..* | AUCoreLocation | A location in an Australian healthcare context au-core-loc-01: The location shall at least have a valid identifier or address or type inv-dh-loc-02: If present, the managing organization shall at least have a reference, an identifier or a display inv-dh-loc-03: If present, a location this location is a part of shall at least have a reference, an identifier or a display | ||||||
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 | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | SOC | 0..* | Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber | 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 | SOΣ | 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 | |||||||
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||||
mode | SOΣ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
| ||||||
type | SOΣC | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
| ||||||
telecom | 0..* | ContactPoint | Contact details of the location | |||||||
address | SOC | 0..1 | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
| ||||||
physicalType | SOΣ | 0..1 | CodeableConcept | Physical form of the location Binding: Location Type (Physical) - AU Extended (preferred)
| ||||||
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 | SOΣC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for provisioning and upkeep
| ||||||
partOf | SC | 0..1 | Reference(ADHA Core 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 | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended | ||||
Location.physicalType | preferred | LocationPhysicalTypeAUExtendedhttp://terminology.hl7.org.au/ValueSet/location-physical-type-extended | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-loc-02 | error | Location | If present, the managing organization shall at least have a reference, an identifier or a display : managingOrganization.exists() implies managingOrganization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-loc-03 | error | Location | If present, a location this location is a part of shall at least have a reference, an identifier or a display : partOf.exists() implies partOf.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUCoreLocation
Other representations of profile: CSV, Excel, Schematron