# Health Connect Australia Provider Directory FHIR Implementation Guide

26.0.0 - Snapshot HL7 AU Connectathon Aug 25 & 26, 2026

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-Snapshot-26.0.0-HL7AU-Connectathon-Aug-25-26/ and changes regularly. See the Directory of published versions

## Resource Profile: HCPD Location

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location | Version: 26.0.0
Active as of 2026-08-14 | Computable Name: HCPD_Location
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 defines a Health Connect Provider Directory entry for a healthcare location where services are provided.

This profile addresses the business need to standardise location information in the Health Connect Provider Directory, enabling consistent representation of physical, mobile, and virtual healthcare service delivery sites for directory search and service location purposes.

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

### Extensions

Extensions introduced in this profile:

- Location: Amenity
- Location: HCPD Alternate Postal Address
- Location: Suppressed
- Location: Deactivated

### Visibility and Suppression

The HCPD Location profile supports the Suppressed extension, however its application is conceptually driven by organizational visibility decisions. When an HCPD Organization elects to hide their visibility from those searching the Health Connect Provider Directory system by applying the suppressed extension with an `organisation-initiated` code, all associated Location resources are automatically suppressed and excluded from Provider Directory listings. This cascading suppression ensures that when an organization chooses to hide their visibility, related locations "come for the ride" and are similarly hidden from display, maintaining consistency across the directory.

### Usage notes

Publishing guidance:

A HC Location resource may also have additional identifiers specific to other business partners, and their identifier systems may or may not match other identifier slices defined in AU Core Location.

#### Identifiers

Beyond the identifiers already defined in AU Core the HC Location profile explicitly supports the following identifier slice (as indicated by the must support flag):

- HCPD Local Identifier (hcpd-LI) - Unique identifier attributed by the HCPD system.

#### Type

The usage notes of the AU Base Location profile provide guidance for Locations that may form part of defining a mobile or remotely delivered service. The HCPD Location profile formalises this guidance as mandatory requirements (via invariants). The requirements are summarised below:

A HCPD Location for a mobile service shall have:

- type=’MOBL’ plus at least one of the following codes: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB', to further qualify where the mobile service is offered.

A HCPD Location for a virtually delivered service shall have:

- type=’VI’

##### PhysicalType

When a Location is to be represented as a physical type, the `physicalType` element is used to carry an applicable code from the Location Type (Physical) - AU Extended ValueSet.

The `physicalType` element can be used to express more specific details about the physical nature of a Location (for example: ward, building, dwelling).

#### Organization reference

The managingOrganization element must contain a relative reference to an existing HC Organization.

#### Invariants

##### Invariant: hcpd-alternate-postal-address

Description: If the alternate postal address extension is present on an address then that address must be of type 'postal'.

Implementation note: The profile enforces this rule so that the `hcpd-alternate-postal-address` extension is only used to carry postal/mailing addresses (for example PO Boxes). Publishing systems SHOULD only set the extension on addresses whose `type` is `postal`.

##### Invariant: inv-01-address-requirement

Description: If a location's `type` is `VI` or `MOBL` then an address does not need to be present. For all other location types an `address` MUST be present.

Implementation note: This invariant ensures that physical locations provide a postal/physical address, while virtual or mobile services (for example telehealth, mobile clinics, ambulance services) may omit a fixed address.

##### Invariant: inv-02-type-mobl-requires-modifier

Description: If a location's `type` includes the `MOBL` code then it is recommended that an additional modifier coding is provided to describe the mobile service (either `PTRES`, `SCHOOL`, `WORK`, `COMM`, `AMB`) but not `VI`.

Implementation note: This rule is a warning - it does not block publishing but encourages publishers to provide additional context about where the mobile service operates. Implementers should supply a secondary `type.coding` entry when describing mobile services to improve discoverability.

##### Invariant: inv-03-type-vi-should-not-have-modifier

Description: If a location's `type` includes the `VI` code then no additional modifier codings should be present.

Implementation note: This rule is a warning - virtual locations should be clearly identified as virtual-only and not include additional modifiers that suggest physical or mobile subtypes. If a virtual service also has a physical component, model those as separate Location resources.

##### Invariant: inv-04-type-or-physicaltype-present

Description: A Location resource MUST include either a `type` or a `physicalType` element.

Implementation note: This rule is enforced as an error - every Location must be classified either by `type` (logical role such as `MOBL`, `VI`, etc.) or by `physicalType` (when the Location represents a specific physical characteristic). Implementers MUST populate at least one of these elements when creating Location resources.

##### Invariant: inv-05-status-values

Description: Location.`status` must be `active` or `inactive`. The `suspended` status is not used in HCPD.

Implementation note: This rule is enforced as an error - HCPD only recognises active and inactive states for a Location. Publishing systems MUST NOT set `status` to `suspended`. When a Location is no longer available it should be set to `inactive`.

Usages:

- Refer to this Profile: HCPD HealthcareService, HCPD Location, HCPD PractitionerRole and HCPD Provenance
- Examples for this Profile: Sydney Central Medical Centre, Mobile Healthcare Unit - Sydney CBD, Sydney CBD Mobile Unit Service Area and Virtual Telehealth Service
- CapabilityStatements using this Profile: Health Connect Provider Directory Requester and Health Connect Provider Directory Responder

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry Constraints: au-core-loc-01, inv-01-address-requirement, inv-02-type-mobl-requires-modifier, inv-03-type-vi-should-not-have-modifier, inv-04-type-or-physicaltype-present, inv-05-status-values
meta | Σ | 0..1 | Meta | Metadata on Location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required) Constraints: ext-1
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address Constraints: ext-1
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | S Σ C | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO Σ C | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO Σ C | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | ?!SO Σ | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory. Binding: LocationStatus (required): Indicates whether the location is still in use.
Obligations | Actor
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
name | SO Σ | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
type | SO Σ C | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email | S | 0..* | ContactPoint | Email address for the location.
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | SO C | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
physicalType | SO Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
managingOrganization | SO Σ | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | Another Location this one is physically a part of
endpoint | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
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 | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au
Location.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Location.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
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-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

This structure is derived from AUCoreLocation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry
meta |  | 0..1 | Meta | Metadata on Location
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Obligations | Actor
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
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required)
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Obligations | Actor
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
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
Slices for identifier | S | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | SO | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory.
Obligations | Actor
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
name | O | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
type | O | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:email | S | 0..* | ContactPoint | Email address for the location.
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
address | O | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
managingOrganization | O | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | Another Location this one is physically a part of
endpoint | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Location.type | Base | extensible | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-address-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry Constraints: au-core-loc-01, inv-01-address-requirement, inv-02-type-mobl-requires-modifier, inv-03-type-vi-should-not-have-modifier, inv-04-type-or-physicaltype-present, inv-05-status-values
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required) Constraints: ext-1
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address Constraints: ext-1
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | S Σ C | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO Σ C | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO Σ C | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | ?!SO Σ | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory. Binding: LocationStatus (required): Indicates whether the location is still in use.
Obligations | Actor
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
operationalStatus | Σ | 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).
name | SO Σ | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | SO Σ C | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S | 0..* | ContactPoint | Email address for the location.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | SO C | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
physicalType | SO Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Σ | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | 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 Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
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.3
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std.
Location.type | Base | extensible | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au
Location.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Location.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
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-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

This structure is derived from AUCoreLocation

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- HCPD Source Identifier (HCPD-SI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier|26.0.0)
- HCPD Local Identifier (HCPD-LI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-local-identifier|26.0.0)
- HCPD Organization (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0)
- HCPD Location (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0)
- HCPD Endpoint (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0)

Extensions

This structure refers to these extensions:

- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed|26.0.0
- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated|26.0.0

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Location.identifier
- The element 1 is sliced based on the value of Location.telecom

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry Constraints: au-core-loc-01, inv-01-address-requirement, inv-02-type-mobl-requires-modifier, inv-03-type-vi-should-not-have-modifier, inv-04-type-or-physicaltype-present, inv-05-status-values
meta | Σ | 0..1 | Meta | Metadata on Location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required) Constraints: ext-1
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address Constraints: ext-1
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
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
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | S Σ C | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO Σ C | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO Σ C | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | ?!SO Σ | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory. Binding: LocationStatus (required): Indicates whether the location is still in use.
Obligations | Actor
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
name | SO Σ | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
type | SO Σ C | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email | S | 0..* | ContactPoint | Email address for the location.
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address | SO C | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
physicalType | SO Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
managingOrganization | SO Σ | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | Another Location this one is physically a part of
endpoint | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
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 | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au
Location.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Location.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
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-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

Differential View

This structure is derived from AUCoreLocation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry
meta |  | 0..1 | Meta | Metadata on Location
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Obligations | Actor
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
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required)
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Obligations | Actor
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
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
Slices for identifier | S | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | SO | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory.
Obligations | Actor
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
name | O | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
type | O | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
telecom:email | S | 0..* | ContactPoint | Email address for the location.
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email
address | O | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
managingOrganization | O | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | Another Location this one is physically a part of
endpoint | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Location.type | Base | extensible | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-address-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location | C | 0..* | AUCoreLocation(2.0.0) | Australian Location Directory Entry Constraints: au-core-loc-01, inv-01-address-requirement, inv-02-type-mobl-requires-modifier, inv-03-type-vi-should-not-have-modifier, inv-04-type-or-physicaltype-present, inv-05-status-values
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:suppressed | SO | 0..1 | (Complex) | Indicates if Location service is suppressed URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:amenity | SO | 0..* | CodeableConcept | Amenities or facilities available at or near the location. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity Binding: Facility Amenity (required) Constraints: ext-1
Obligations | Actor
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
extension:hcpd-alternate-postal-address | SO | 0..* | Address | Alternate postal address URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address Constraints: ext-1
Obligations | Actor
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
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Location service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | S Σ C | 2..* | Identifier(4.0.1), AULocationSpecificPracticeNumber(6.0.0), AUNATASiteNumber(6.0.0) | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type
identifier:HCPD_Source_Identifier | SO Σ C | 1..1 | HCPD_Source_Identifier(26.0.0) | Identifier attributed from source system. Source for Location: PCA
Obligations | Actor
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
identifier:HCPD_Local_Identifier | SO Σ C | 1..1 | HCPD_Local_Identifier(26.0.0) | Local Identifier for the location attributed by HC
Obligations | Actor
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
status | ?!SO Σ | 1..1 | code | Used to show if this location is in operation. Only locations with status ‘Active’ are exposed externally and discoverable/visible in the directory. Binding: LocationStatus (required): Indicates whether the location is still in use.
Obligations | Actor
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
operationalStatus | Σ | 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).
name | SO Σ | 1..1 | string | Name of the location as used by humans
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
alias | SO | 0..* | string | Alternative names for the location
Obligations | Actor
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
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type | SO Σ C | 0..* | CodeableConcept | Indicates whether the location is a virtual location or mobile service. Binding: Service Delivery Location Role Type (extensible)
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
Slices for telecom | SO | 0..* | ContactPoint | Contact details of the location Slice: Unordered, Open by value:system
Obligations | Actor
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
telecom:phone | S | 0..* | ContactPoint | Phone number for the location.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
telecom:email | S | 0..* | ContactPoint | Email address for the location.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value | Σ | 0..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | SO C | 0..1 | Address(4.0.1), AustralianAddress(6.0.0) | Address where the service or practitioner role is located. Virtual and mobile locations may not have a fixed address.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHOULD:handle | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
physicalType | SO Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationPhysicalTypeAUExtended (6.0.0) (preferred)
position | SO | 0..1 | BackboneElement | The absolute geographic location
Obligations | Actor
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 Σ | 1..1 | Reference(HCPD Organization(26.0.0)) | Reference to managing organisation with HPI-O.
Obligations | Actor | Source
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor |
SHALL:ignore | Health Connect Provider Directory Requester Actor | from AU Core Location
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor |
partOf |  | 0..1 | Reference(HCPD Location(26.0.0)) | 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 Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
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 | SO | 0..* | Reference(HCPD Endpoint(26.0.0)) | Technical endpoints providing access to services operated for the location
Obligations | Actor
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
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.3
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std.
Location.type | Base | extensible | Service Delivery Location Role Type | ⏿1.0.0 | tx.hl7.org.au
Location.telecom:phone.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:phone.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Location.telecom:email.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Location.telecom:email.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
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-requirement | warning | Location | Physical locations (not virtual or mobile) must have an address present. | `physicalType.exists() implies address.exists()`
inv-02-type-mobl-requires-modifier | warning | Location | If a location is marked as mobile (code 'MOBL') it is recommended that a modifier coding is provided to describe the mobile type | `type.coding.where(code = 'MOBL').exists() implies type.coding.where(code = 'COMM' or code = 'AMB' or code = 'PTRES' or code = 'SCHOOL' or code = 'WORK').exists()`
inv-03-type-vi-should-not-have-modifier | warning | Location | If a location is marked as virtual (code 'VI') no additional modifier codings are needed | `type.coding.where(code = 'VI').exists() implies type.coding.count() = 1`
inv-04-type-or-physicaltype-present | error | Location | A Location MUST have either a `type` or a `physicalType` value present | `type.exists() or physicalType.exists()`
inv-05-status-values | error | Location | Location.status must be 'active' or 'inactive'. The 'suspended' status is not used in HCPD. | `status = 'active' or status = 'inactive'`

This structure is derived from AUCoreLocation

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- HCPD Source Identifier (HCPD-SI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier|26.0.0)
- HCPD Local Identifier (HCPD-LI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-local-identifier|26.0.0)
- HCPD Organization (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0)
- HCPD Location (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0)
- HCPD Endpoint (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0)

Extensions

This structure refers to these extensions:

- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed|26.0.0
- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/amenity|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-alternate-postal-address|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated|26.0.0

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Location.identifier
- The element 1 is sliced based on the value of Location.telecom

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search parameters

This IG defines and introduces several search parameters in addition to those inherited from R4, that make it easier to find and filter `HC Location` resources in Health Connect implementations.

#### Search parameters defined in this IG

The following search parameters are defined by this IG and SHOULD be supported:

- `locmailaddress` (Location.extension where url = HC preferred postal address extension). Supports `:contains` modifier.
  - Search locations by the hcpd-preferred postal address stored in the location's hcpd-specific extension.
  - Example (string-only): `GET /Location?locmailaddress=PO%20Box%20123`
- `locationamenities` (Location.extension where url = HC amenity extension)
  - Search for locations by their amenities using the HC amenity extension. Use token semantics for coded amenity values.
  - Example (display text): `GET /Location?locationamenities=WheelchairAccess`
- `locationphysicaltype` (Location.physicalType)
  - Search for locations by their physicalType field. Use token semantics for coded physical type values from the Location Type (Physical) ValueSet.
  - Example: `GET /Location?locationphysicaltype=http://terminology.hl7.org/CodeSystem/location-physical-type|wa`
- `suppressed` (Location.extension where url = suppressedBy extension)
  - Search for locations by their suppression status. Use token semantics with a code from the Responsible Party Type CodeSystem.
  - Example (system|code): `GET /Location?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|practitioner-initiated`
  - Example (code only): `GET /Location?suppressed=practitioner-initiated`
  - Example (system only): `GET /Location?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|`

#### Search parameters from R4

The following search parameters are inherited from FHIR R4 and have been deemed useful for implementation within this IG. They SHOULD be supported:

- `name (R4)` (Location.name and Location.alias)
  - Search for locations by name and alias (partial searches supported).
  - Example: `GET /Location?name:contains=Telehealth`
- `address (R4)` (Location.address)
  - Search for locations by address (partial searches supported).
  - Example: `GET /Location?address=147-153%20Castlereagh%20Street`
- `type (R4)` (Location.type.coding)
  - Search for locations by their type using coded values. Use token semantics for precise code matching.
  - Available codes = MOBL, PTRES, SCHOOL, WORK, COMM, AMB, VI from the NCTS Delivery Location Role Type ValueSet
  - Example (code only): `GET /Location?type=MOBL`
- `near` (Location.position)

  - Search for locations by geographical proximity using latitude | longitude | distance format.

  - Results can be sorted by distance using the `_sort` parameter. Documented here under GitHub issue #4650.

  - Sort modifiers: `_sort=near` (closest first), `_sort=-near` (furthest first).
  - Example: `GET /Location?near=-33.8688|151.2093|0.5` (within 0.5km of Sydney CBD coordinates)
  - Example with sorting: `GET /Location?near=-33.8688|151.2093|3&_sort=near` (closest locations first within 3km)
- `status`
  - For HC Location records, implementers SHALL use only the following `Location.status` values: `active` or `inactive`. The `suspended` status is not used in HCPD.

  - Example: `GET /Location?status=active`

    Note: Adding `?status=inactive` records that are inactive. Implementers should be aware that returned results MAY include records marked for suppression; it is the responsibility of the implementer that suppressed records SHALL be filtered out before display.

Implementation note: `Location.status` values are constrained to `active` or `inactive` only. The `suspended` status is not used in HCPD.

Note: Support for _id is mandatory for a responder and optional for a requester. Where the expectation for a search parameter differs between actors, the table below will reflect the stronger conformance requirement.

Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | ---
_id | SHOULD | `token` |
name (R4) | SHOULD | `string` |
address (R4) | SHOULD | `string` |
locmailaddress | SHOULD | `string` |
locationamenities | SHOULD | `token` |
locationphysicaltype | SHOULD | `token` |
suppressed | SHOULD | `token` |
type (R4) | SHOULD | `token` |
near (R4) | SHOULD | `special` | Geographical proximity search using latitude|longitude|distance format. Can be sorted by distance using _sort=near
status (R4) | SHOULD | `token` |
name+type | SHOULD | `string`+`token` |
name+locationphysicaltype | SHOULD | `string`+`token` |
name+locationamenities | SHOULD | `string`+`token` |
address+type | SHOULD | `string`+`token` |
address+locationphysicaltype | SHOULD | `string`+`token` |
address+locationamenities | SHOULD | `string`+`token` |
locmailaddress+type | SHOULD | `string`+`token` |
locmailaddress+locationphysicaltype | SHOULD | `string`+`token` |
locmailaddress+locationamenities | SHOULD | `string`+`token` |

### Search include parameters

This implementation supports the following `_include` parameters when searching for Location resources:

- `_include=Location:endpoint` - Include endpoint resources referenced by the `endpoint` element
- `_include=Location:organization` - Include organization resources referenced by the `managingOrganization` element

### Search reverse include parameters

This implementation supports the following `_revinclude` parameters when searching for Location resources:

- `_revinclude=HealthcareService:location` - Include HealthcareService resources that reference this Location
- `_revinclude=Provenance:target` - Include Provenance resources that track changes to this Location

#### Example usage

    GET /Location/456?_include=Location:endpoint&_revinclude=HealthcareService:location

This query returns the Location resource, its associated Endpoints, and all HealthcareServices at this Location.