Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

StructureDefinition: ADHA Core Location [Active]

The purpose of this profile is to define a core representation of a location for the electronic exchange of digital health information between healthcare providers, and between 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:

  • Recording or updating a location referenced by another resource
  • Reading locations referenced by another resource

Profile specific guidance

None.

Boundaries and relationships

This profile is referenced by ADHA Core Encounter, ADHA Core Flag, ADHA Core HealthcareService, ADHA Authoring PractitionerRole, and ADHA Core PractitionerRole.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-location-core-1

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.

This profile builds on AUBaseLocation.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-dh-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
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... name S0..1stringName of the location as used by humans
... description S0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode S0..1codeinstance | kind
... type SC0..*CodeableConceptType of function performed
... address SC0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization SC0..1Reference(ADHA Core Organization)Organization responsible for provisioning and upkeep
... partOf SC0..1Reference(ADHA Core Location)Another Location this one is physically a part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-dh-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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe 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 SΣ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣC0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
... telecom 0..*ContactPointContact details of the location
... address SC0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣC0..1Reference(ADHA Core Organization)Organization responsible for provisioning and upkeep
... partOf SC0..1Reference(ADHA Core Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-dh-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
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... name S0..1stringName of the location as used by humans
... description S0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode S0..1codeinstance | kind
... type SC0..*CodeableConceptType of function performed
... address SC0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization SC0..1Reference(ADHA Core Organization)Organization responsible for provisioning and upkeep
... partOf SC0..1Reference(ADHA Core Location)Another Location this one is physically a part of

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
inv-dh-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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe 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 SΣ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description SΣ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣC0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
... telecom 0..*ContactPointContact details of the location
... address SC0..1Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣC0..1Reference(ADHA Core Organization)Organization responsible for provisioning and upkeep
... partOf SC0..1Reference(ADHA Core Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Search Parameters

None defined.