Provider Connect Australia (PCA)
2.4.3 - active Australia flag

Provider Connect Australia (PCA) - Local Development build (v2.4.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PCA Service Coverage Area

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-service-coverage-area Version: 2.4.3
Active as of 2024-03-19 Computable Name: PcaServiceCoverageArea

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of Location represents a geographic area in which a service is available, defined using a combination of address.country, address.state, address.city, and address.postalCode.

Must support

The meaning of the presence or absence of the must support flag is described in Must support.

Extensions

No extensions have been introduced in this profile.

Usage notes

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

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

  • address.country = ‘AU’

To define a coverage area for a particular state, the following elements should be populated:

To define a coverage area for a particular suburb, the following elements should be populated:

Supported interactions

The PCA API specification does not directly support operations on this profile. A PCA Service Coverage Area resource cannot be created, updated or retrieved independently from the PCA Healthcare Service that it is contained within.

Usage:

Formal Views of Profile Content

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

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... meta S0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... city S0..1stringAustralian city, town or suburb
.... state S0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode S0..1stringPostal code for area
.... country S1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... meta SΣ0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... city SΣ0..1stringAustralian city, town or suburb
Example General: Erewhon
.... state SΣ0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..*ContactPointContact details of the location
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringAustralian city, town or suburb
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')

This structure is derived from Location

Summary

Mandatory: 2 elements
Must-Support: 7 elements
Fixed Value: 1 element

Differential View

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... meta S0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... city S0..1stringAustralian city, town or suburb
.... state S0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode S0..1stringPostal code for area
.... country S1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... meta SΣ0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... city SΣ0..1stringAustralian city, town or suburb
Example General: Erewhon
.... state SΣ0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationGeographic area in which a service is available.
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id S0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..*ContactPointContact details of the location
... address SC1..1AddressPhysical location
inv-pca-1: if present, postalCode shall be 4 digits
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringAustralian city, town or suburb
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringAustralian state or territory
Binding: Australian States and Territories . (required)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Location.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.staterequiredAustralianStatesAndTerritories .
https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocation.addressif present, postalCode shall be 4 digits
: postalCode.matches('^[0-9]{4,4}$')

This structure is derived from Location

Summary

Mandatory: 2 elements
Must-Support: 7 elements
Fixed Value: 1 element

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No additional search parameters defined for this resource profile.