AU Base Implementation Guide
5.0.1-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 5.0.1-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: 5.0.1-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”

Usage:

Changes since version 5.0.0:

  • No changes

    • Formal Views of Profile Content

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

    This structure is derived from Location

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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location TU 0..* Location A location in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... identifier Σ 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ele-1: All FHIR elements must have a @value or children
    ... type Σ 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    ... address 0..1 Address, AustralianAddress Physical location
    ele-1: All FHIR elements must have a @value or children
    ... physicalType Σ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location TU 0..* Location A location in an Australian healthcare context
    ... 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
    ... 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 Σ 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 Σ 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 Σ 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

    ... type Σ 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ... telecom 0..* ContactPoint Contact details of the location
    ... address 0..1 Address, AustralianAddress Physical location
    ... physicalType Σ 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 Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
    ... partOf 0..1 Reference(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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.operationalStatuspreferredHl7VSBedStatus
    http://terminology.hl7.org/ValueSet/v2-0116
    Location.moderequiredLocationMode
    http://hl7.org/fhir/ValueSet/location-mode|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG
    Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
    http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from Location

    Summary

    Maturity: 3

    Differential View

    This structure is derived from Location

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

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location TU 0..* Location A location in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... identifier Σ 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
    ele-1: All FHIR elements must have a @value or children
    ... type Σ 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ele-1: All FHIR elements must have a @value or children
    ... address 0..1 Address, AustralianAddress Physical location
    ele-1: All FHIR elements must have a @value or children
    ... physicalType Σ 0..1 CodeableConcept Physical form of the location
    Binding: Location Type (Physical) - AU Extended (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Location TU 0..* Location A location in an Australian healthcare context
    ... 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
    ... 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 Σ 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 Σ 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 Σ 0..1 code instance | kind
    Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

    ... type Σ 0..* CodeableConcept Type of function performed
    Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
    ... telecom 0..* ContactPoint Contact details of the location
    ... address 0..1 Address, AustralianAddress Physical location
    ... physicalType Σ 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 Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
    ... partOf 0..1 Reference(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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Location.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Location.statusrequiredLocationStatus
    http://hl7.org/fhir/ValueSet/location-status|4.0.1
    from the FHIR Standard
    Location.operationalStatuspreferredHl7VSBedStatus
    http://terminology.hl7.org/ValueSet/v2-0116
    Location.moderequiredLocationMode
    http://hl7.org/fhir/ValueSet/location-mode|4.0.1
    from the FHIR Standard
    Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/v3-ServiceDeliveryLocationRoleType-extended
    from this IG
    Location.physicalTypepreferredLocationPhysicalTypeAUExtended
    http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
    from this IG
    Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
    http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceLocationA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust 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