AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Location

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-location Version: 0.1.0-draft
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreLocation

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

​This profile sets minimum expectations for a Location resource to record, search, and fetch information about a location. It is based on the AU Base Location profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Location when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Record or update basic information for a location
  • Read information about a location referenced by another resource

Profile specific implementation guidance

None.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... 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
... 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 S0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-loc-01errorLocationThe location shall at least have a valid identifier or address or type
: address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... name SΣ0..1stringName of the location as used by humans
... 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)
... 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)
... managingOrganization SΣ0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.statusrequiredLocationStatus
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
Location.physicalTypepreferredLocationPhysicalTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
au-core-loc-01errorLocationThe location shall at least have a valid identifier or address or type
: address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... 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
... 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Σ0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(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

Terminology Bindings

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

This structure is derived from AUBaseLocation

Summary

Must-Support: 8 elements

Structures

This structure refers to these other structures:

Maturity: 0

Differential View

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... 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
... 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 S0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-loc-01errorLocationThe location shall at least have a valid identifier or address or type
: address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SC0..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
... name SΣ0..1stringName of the location as used by humans
... 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)
... 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)
... managingOrganization SΣ0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Location.statusrequiredLocationStatus
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleTypeAUExtended
Location.physicalTypepreferredLocationPhysicalTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
au-core-loc-01errorLocationThe location shall at least have a valid identifier or address or type
: address.exists() or type.exists() or identifier.where(system.count() + value.count() >1).exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... 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
... 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Σ0..1Reference(AU Core Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(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

Terminology Bindings

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

This structure is derived from AUBaseLocation

Summary

Must-Support: 8 elements

Structures

This structure refers to these other structures:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
TBD TBD TBD TBD TBD

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported: