Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD/ and changes regularly. See the Directory of published versions

Resource Profile: HCPD Service Coverage Area

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-service-coverage-area Version: 26.0.0
Active as of 2026-11-03 Computable Name: HCPD_Service_Coverage_Area

Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

This profile of Location represents an Australian geographic coverage area i.e. postcodes where this service is provided. For a healthcare service, that is provided through a physical location but have eligibility restrictions applicable in terms of only residents for certain postcodes/suburbs can receive this service, then the details of coverage area and eligibility should be provided here.

No data is entered directly into Health Connect; all Directory content is sourced from authoritative systems including PCA, HI-Service, and NHSD.

Service coverage area in Health Connect

The address that defines the coverage area where the service is available is represented by this profile. The HCPD Service Coverage Area profile is applied to FHIR Location resources to describe an Australian geographic area (postcode, suburb, or region) in which a healthcare service is available.

This profile is referenced by the HCPD HealthcareService profile via the coverageArea element, allowing each healthcare service to specify one or more geographic areas where the service is offered. It may also be referenced by other profiles that need to describe service eligibility or restrictions based on geography.

Usage notes

The coverage area that a service is intended for/available to can be represented as one or more instances of Location, where the address elements are populated depending on the type of coverage area to be defined.

To define an Australia-wide coverage area, only the following element shall be populated:

  • address.country

To define a coverage area for a particular state, the following elements should be populated in addition to address.country:

  • address.state

To define a coverage area for a particular suburb, the following elements should be populated in addition to address.country:

  • address.city
  • address.postalCode
  • address.state

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Constraints: au-core-loc-01, inv-01-address-postalcode-4-digits
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy This element must be supported. 1..1 Extension Who initiated the suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url 1..1 uri "suppressedBy"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf This element must be supported. 0..1 Extension Controls Organization self-suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url 1..1 uri "includeSelf"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x] This element must be supported. 0..1 boolean Value of extension
Location.Slices for extension.extension:suppressed.url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy This element must be supported. 1..1 Extension Who initiated the deactivation
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url 1..1 uri "deactivatedBy"
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated.url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
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.name This element has obligations and must be supported. This element is included in summaries. 0..1 string Name of the location as used by humans
Location.type This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleTypeAUExtended (6.0.0) (extensible)
Location.address This element has obligations and must be supported. C 1..1 Address(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.city This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian city, town or suburb
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.state This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.physicalType This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
Location.managingOrganization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.extension:deactivated.​extension:deactivatedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown
Location.physicalType Base preferred Location Type (Physical) - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')

This structure is derived from AUCoreLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Location.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy 1..1 Extension Who initiated the suppression
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. 1..1 Coding Code defined by a terminology system
Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy 1..1 Extension Who initiated the deactivation
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. 1..1 Coding Code defined by a terminology system
Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.address This element has obligations. 1..1 Address(4.0.1), AustralianAddress(6.0.0) The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.city This element has obligations and must be supported. 0..1 string Australian city, town or suburb
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.state This element has obligations and must be supported. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. 0..1 string Postal code for area
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.managingOrganization This element has obligations. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Constraints: au-core-loc-01, inv-01-address-postalcode-4-digits
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy This element must be supported. 1..1 Extension Who initiated the suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url 1..1 uri "suppressedBy"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf This element must be supported. 0..1 Extension Controls Organization self-suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url 1..1 uri "includeSelf"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x] This element must be supported. 0..1 boolean Value of extension
Location.Slices for extension.extension:suppressed.url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy This element must be supported. 1..1 Extension Who initiated the deactivation
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url 1..1 uri "deactivatedBy"
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.Slices for extension.extension:deactivated.url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Location.identifier This element is included in summaries. C 0..* Identifier(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AULocationSpecificPracticeNumber(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATASiteNumber(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. 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: Hl7VSBedStatus (3.0.0) (preferred): The operational status if the location (where typically a bed/room).
Location.name This element has obligations and must be supported. 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 has obligations and must be supported. This element is included in summaries. C 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleTypeAUExtended (6.0.0) (extensible)
Location.telecom 0..* ContactPoint Contact details of the location
Location.address This element has obligations and must be supported. C 1..1 Address(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian city, town or suburb
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationPhysicalTypeAUExtended (6.0.0) (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
Constraints: ext-1
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
Constraints: ext-1
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 has obligations and must be supported. This element is included in summaries. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
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
Constraints: ext-1
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
Constraints: ext-1
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.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.extension:deactivated.​extension:deactivatedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📍3.0.0 THO v7.5
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown
Location.physicalType Base preferred Location Type (Physical) - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')

This structure is derived from AUCoreLocation

Summary

Mandatory: 2 elements
Must-Support: 8 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Constraints: au-core-loc-01, inv-01-address-postalcode-4-digits
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy This element must be supported. 1..1 Extension Who initiated the suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url 1..1 uri "suppressedBy"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf This element must be supported. 0..1 Extension Controls Organization self-suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url 1..1 uri "includeSelf"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x] This element must be supported. 0..1 boolean Value of extension
Location.Slices for extension.extension:suppressed.url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy This element must be supported. 1..1 Extension Who initiated the deactivation
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url 1..1 uri "deactivatedBy"
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated.url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
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.name This element has obligations and must be supported. This element is included in summaries. 0..1 string Name of the location as used by humans
Location.type This element has obligations and must be supported. This element is included in summaries. C 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleTypeAUExtended (6.0.0) (extensible)
Location.address This element has obligations and must be supported. C 1..1 Address(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.city This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian city, town or suburb
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.state This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.physicalType This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
Location.managingOrganization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.extension:deactivated.​extension:deactivatedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown
Location.physicalType Base preferred Location Type (Physical) - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')

Differential View

This structure is derived from AUCoreLocation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Location.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy 1..1 Extension Who initiated the suppression
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. 1..1 Coding Code defined by a terminology system
Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy 1..1 Extension Who initiated the deactivation
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. 1..1 Coding Code defined by a terminology system
Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.address This element has obligations. 1..1 Address(4.0.1), AustralianAddress(6.0.0) The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.city This element has obligations and must be supported. 0..1 string Australian city, town or suburb
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.state This element has obligations and must be supported. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. 0..1 string Postal code for area
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.managingOrganization This element has obligations. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location C 0..* AUCoreLocation(2.0.0) Australian geographic area in which a service is available.
Constraints: au-core-loc-01, inv-01-address-postalcode-4-digits
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed This element has obligations and must be supported. 0..1 (Complex) Indicates if Location service is suppressed
URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:suppressed.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy This element must be supported. 1..1 Extension Who initiated the suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url 1..1 uri "suppressedBy"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf This element must be supported. 0..1 Extension Controls Organization self-suppression
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url 1..1 uri "includeSelf"
Location.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x] This element must be supported. 0..1 boolean Value of extension
Location.Slices for extension.extension:suppressed.url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Location.Slices for extension.extension:deactivated This element has obligations and must be supported. 0..1 (Complex) Indicates if service coverage area is suppressed
URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHALL:ignore Health Connect Provider Directory Requester Actor
SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
Location.Slices for extension.extension:deactivated.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension Content/Rules for all slices
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy This element must be supported. 1..1 Extension Who initiated the deactivation
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url 1..1 uri "deactivatedBy"
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x] This element must be supported. 1..1 CodeableConcept Value of extension
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].id 0..1 string Unique id for inter-element referencing
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding This element must be supported. This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)

Fixed Value:
{
  "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type",
  "code" : "organisation-initiated"
}
Location.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.Slices for extension.extension:deactivated.url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Location.identifier This element is included in summaries. C 0..* Identifier(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AULocationSpecificPracticeNumber(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATASiteNumber(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. 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: Hl7VSBedStatus (3.0.0) (preferred): The operational status if the location (where typically a bed/room).
Location.name This element has obligations and must be supported. 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 has obligations and must be supported. This element is included in summaries. C 0..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleTypeAUExtended (6.0.0) (extensible)
Location.telecom 0..* ContactPoint Contact details of the location
Location.address This element has obligations and must be supported. C 1..1 Address(4.0.1) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress(6.0.0) The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The address that defines the coverage area where the service is available
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Location.address.city This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian city, town or suburb
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element has obligations and must be supported. This element is included in summaries. 0..1 string Australian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.postalCode This element has obligations and must be supported. This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.country This element has obligations and must be supported. This element is included in summaries. 1..1 string Australia as a 2 digit ISO 3166 code
Required Pattern: AU (extensions allowed)
ObligationsActor
SHALL:populate-if-known Health Connect Provider Directory Responder Actor
SHOULD:handle Health Connect Provider Directory Requester Actor
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationPhysicalTypeAUExtended (6.0.0) (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
Constraints: ext-1
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
Constraints: ext-1
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 has obligations and must be supported. This element is included in summaries. 0..1 Reference(HCPD Organization(26.0.0)) Organization responsible for provisioning and upkeep
ObligationsActorSource
SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core Location
SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
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
Constraints: ext-1
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
Constraints: ext-1
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.extension:suppressed.​extension:suppressedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.extension:deactivated.​extension:deactivatedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📍3.0.0 THO v7.5
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 Not State Unknown
Location.physicalType Base preferred Location Type (Physical) - AU Extended 📍6.0.0 AU Base Implementation Guide v6.0
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
inv-01-address-postalcode-4-digits error Location If present, postalCode shall be 4 digits address.postalCode.empty() or address.postalCode.matches('^[0-9]{4}$')

This structure is derived from AUCoreLocation

Summary

Mandatory: 2 elements
Must-Support: 8 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron