AU Core Implementation Guide
1.0.0-ballot - Ballot Australia flag

This page is part of the AU Core (v1.0.0-ballot: AU Core R1 Ballot 7) based on FHIR (HL7® FHIR® Standard) R4. . 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: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: AUCoreLocation

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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

Comparison with other national and international IGs

A resource conforming to this profile:

No equivalent International Patient Access or International Patient Summary profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.
  • 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

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 C 0..* AUBaseLocation A location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... identifier SOC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SO 0..1 string Name of the location as used by humans
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... mode SO 0..1 code instance | kind
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SOC 0..1 Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SO 0..1 CodeableConcept Physical form of the location
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... managingOrganization SO 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

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 C 0..* AUBaseLocation A 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..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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SOΣ 0..1 string Name of the location as used by humans
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... mode SOΣ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... type SOΣC 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SOC 0..1 Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

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.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
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

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()
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 C 0..* AUBaseLocation A 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..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 SOC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... type SOΣC 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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Σ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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()
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 AUBaseLocation

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

Maturity: 1

Differential View

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C 0..* AUBaseLocation A location in an Australian healthcare context
au-core-loc-01: The location shall at least have a valid identifier or address or type
... identifier SOC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SO 0..1 string Name of the location as used by humans
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... mode SO 0..1 code instance | kind
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SOC 0..1 Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SO 0..1 CodeableConcept Physical form of the location
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... managingOrganization SO 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

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 C 0..* AUBaseLocation A 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..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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... name SOΣ 0..1 string Name of the location as used by humans
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... mode SOΣ 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... type SOΣC 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... address SOC 0..1 Address, AustralianAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... managingOrganization SOΣ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester

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.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
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

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()
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 C 0..* AUBaseLocation A 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..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 SOC 0..* Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumber Unique code or number identifying the location to its users
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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.

ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... type SOΣC 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType - AU Extended (extensible)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... physicalType SOΣ 0..1 CodeableConcept Physical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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Σ 0..1 Reference(AU Core Organization) Organization responsible for provisioning and upkeep
ObligationsActor
SHALL:populate-if-known AU Core Responder
SHALL:no-error AU Core Requester
... 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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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()
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 AUBaseLocation

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
address SHALL string
name SHALL string
address-city SHOULD string
address-state SHOULD string
address-postalcode SHOULD string
identifier MAY token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

Mandatory Search Parameters

The following search parameters SHALL be supported:

  1. SHALL support searching based on text address using the address search parameter:

    GET [base]/Location?address=[string]

    Example:

    1. GET [base]/Location?address=QLD
    2. GET [base]/Location?address=QLD

    Implementation Notes: Fetches a bundle of all Location resources matching the name (how to search by string)

  2. SHALL support searching based on text name using the name search parameter:

    GET [base]/Location?name=[string]

    Example:

    1. GET [base]/Location?name=Hospital

    Implementation Notes: Fetches a bundle of all Location resources matching the name (how to search by string)

Optional Search Parameters:

The following search parameters SHOULD be supported:

  1. SHOULD support searching using the address-city search parameter:

    GET [base]/Location?address-city=[string]

    Example:

    1. GET [base]/Location?address-city=Westmead

    Implementation Notes: Fetches a bundle of all Location resources for the city (how to search by string)

  2. SHOULD support searching using the addresss-postalcode search parameter:

    GET [base]/Location?addresss-postalcode=[string]

    Example:

    1. GET [base]/Location?addresss-postalcode=3005

    Implementation Notes: Fetches a bundle of all Location resources matching the post code (how to search by string)

  3. SHOULD support searching using the address-state search parameter:

    GET [base]/Location?address-state=[string]

    Example:

    1. GET [base]/Location?address-state=TAS

    Implementation Notes: Fetches a bundle of all Location resources matching the state (how to search by string)