AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Location

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-location Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 3 Computable Name: AUBaseLocation

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a location structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • When defining a type of mobile or remotely delivered service location:
    • Location.mode is sent as "kind"
    • One instance of Location.type is sent as "MOBL"
    • Additional types of Location.type indicate the service is tailored for delivery in these kinds of locations (e.g. "AMB", "COMM", "PTRES", "SCHOOL", or "WORK").
  • When defining a remotely delivered service location:
    • Location.mode is sent as "kind"
    • Location.type is sent as "VI"
    • Location.physicalType is sent as "vi"
  • When constructing an address:
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Location.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocationSpecificPracticeNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUNATASiteNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Unique code or number identifying the location to its users
    Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Physical location
    Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG

    Constraints

    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())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Location

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.identifier 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    Location.type 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.address 0..1 Address, AustralianAddress Physical location

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.id This element is included in summaries. 0..1 id Logical id of this artifact
    Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Location.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Location.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Location.contained 0..* Resource Contained, inline Resources
    Location.extension 0..* Extension Additional content defined by implementations
    Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Location.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocationSpecificPracticeNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUNATASiteNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Unique code or number identifying the location to its users
    Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    Location.operationalStatus This element is included in summaries. 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).
    Location.name This element is included in summaries. 0..1 string Name of the location as used by humans
    Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
    Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
    Location.mode This element is included in summaries. 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
    Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.telecom 0..* ContactPoint Contact details of the location
    Location.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Physical location
    Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    Location.position 0..1 BackboneElement The absolute geographic location
    Location.position.id 0..1 string Unique id for inter-element referencing
    Location.position.extension 0..* Extension Additional content defined by implementations
    Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Location.position.longitude 1..1 decimal Longitude with WGS84 datum
    Location.position.latitude 1..1 decimal Latitude with WGS84 datum
    Location.position.altitude 0..1 decimal Altitude with WGS84 datum
    Location.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
    Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
    Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
    Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
    Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
    Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
    Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
    Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
    Location.availabilityExceptions 0..1 string Description of availability exceptions
    Location.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
    Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG
    Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    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())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Location

    Summary

    Maturity: 3

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Location.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocationSpecificPracticeNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUNATASiteNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Unique code or number identifying the location to its users
    Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Physical location
    Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG

    Constraints

    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())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Differential View

    This structure is derived from Location

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.identifier 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    Location.type 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.address 0..1 Address, AustralianAddress Physical location
    Location.physicalType 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Location 0..* Location A location in an Australian healthcare context
    Location.id This element is included in summaries. 0..1 id Logical id of this artifact
    Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Location.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Location.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Location.contained 0..* Resource Contained, inline Resources
    Location.extension 0..* Extension Additional content defined by implementations
    Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Location.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AULocationSpecificPracticeNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUNATASiteNumber The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Unique code or number identifying the location to its users
    Location.status This element is a modifier element. This element is included in summaries. 0..1 code active | suspended | inactive
    Binding: LocationStatus (required): Indicates whether the location is still in use.
    Location.operationalStatus This element is included in summaries. 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).
    Location.name This element is included in summaries. 0..1 string Name of the location as used by humans
    Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
    Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
    Location.mode This element is included in summaries. 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
    Location.type This element is included in summaries. 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    Location.telecom 0..* ContactPoint Contact details of the location
    Location.address 0..1 Address The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AustralianAddress The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well Physical location
    Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    Location.position 0..1 BackboneElement The absolute geographic location
    Location.position.id 0..1 string Unique id for inter-element referencing
    Location.position.extension 0..* Extension Additional content defined by implementations
    Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Location.position.longitude 1..1 decimal Longitude with WGS84 datum
    Location.position.latitude 1..1 decimal Latitude with WGS84 datum
    Location.position.altitude 0..1 decimal Altitude with WGS84 datum
    Location.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
    Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
    Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
    Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
    Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
    Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
    Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
    Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
    Location.availabilityExceptions 0..1 string Description of availability exceptions
    Location.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
    Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.4
    Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
    Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📦7.0.0-ci-build This IG
    Location.physicalType Base preferred Location Type (Physical) - AU Extended 📦7.0.0-ci-build This IG
    Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    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())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Location

    Summary

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron