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 Location

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

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 defines a PCA Location. A PCA Location is a location at which services are offered by a PCA publisher.

Must support

The meaning of the presence or absence of the must support flag is described in Must support, except for the following elements:

  • For the id and identifier:pca-li elements: publishing systems creating a new PCA Location resource shall not provide these elements. These identifiers are generated by the PCA service.
  • For the meta.versionId and meta.lastUpdated elements: publishing systems creating or updating a PCA Location resource shall not provide these elements. These values are generated by the PCA service.

Extensions

Extensions introduced in this profile:

Usage notes

Identifiers

The PCA Location profile explicitly supports the following identifier slice (as indicated by the must support flag):

  • PCA Location Identifier (PCA-LI)

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

Status

The status element can only be set to ‘inactive’ if all healthcare services linked to the location have an active value of ‘false’.

Location address

A PCA Location without a type represents a physical location in PCA. A PCA Location without a type must include the physical address of the location in the address element.

Address lines

When a PCA Location is created or updated by a publishing system, or retrieved by a publishing or subscribing system, the line elements for pca-postal-address (if present) and address are processed/populated by PCA using the rules that are defined the usage notes of the PCA Postal Address extension.

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 PCA Location profile formalises this guidance as mandatory requirements (via invariants). The requirements are summarised below:

A PCA Location for a mobile service shall have:

  • mode=’kind’
  • 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 PCA Location for a remotely delivered service shall have:

  • mode=’kind’
  • type=’VI’
  • physicalType=’vi’ (Note: the ‘vi’ code with code system http://terminology.hl7.org.au/CodeSystem/location-physical-type has been deprecated as it has been replaced by an equivalent term provided by HL7 international. The ‘vi’ code with code system http://terminology.hl7.org/CodeSystem/location-physical-type should be used instead.)

Organisation reference

The managingOrganization element must contain a relative reference to an existing PCA Organization. Publishing systems can search for organisations using the PCA Publisher Agent API. After a location has been created, the managingOrganization element cannot be changed to reference a different organisation - this functionality will be supported in a future release of PCA.

Supported interactions

Supported service interactions for this profile are defined in the following capability statements:

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-amenity S0..*CodeableConceptPhysical features within or in close proximity of the location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity
Binding: PCA Amenity (required)
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status SC1..1codeactive | inactive
inv-pca-8: status shall be either 'active' or 'inactive'
... name S1..1stringName of the location as used by humans
... mode S0..1codeinstance | kind
... type S0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization S1..1Reference(PCA Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status ?!SΣC1..1codeactive | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-pca-8: status shall be either 'active' or 'inactive'
... name SΣ1..1stringName of the location as used by humans
... mode SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... managingOrganization SΣ1..1Reference(PCA Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-amenity S0..*CodeableConceptPhysical features within or in close proximity of the location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity
Binding: PCA Amenity (required)
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status ?!SΣC1..1codeactive | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-pca-8: status shall be either 'active' or 'inactive'
... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..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 SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(PCA 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.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4

This structure is derived from AUBaseLocation

Summary

Mandatory: 4 elements
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system

Differential View

This structure is derived from AUBaseLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-amenity S0..*CodeableConceptPhysical features within or in close proximity of the location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity
Binding: PCA Amenity (required)
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status SC1..1codeactive | inactive
inv-pca-8: status shall be either 'active' or 'inactive'
... name S1..1stringName of the location as used by humans
... mode S0..1codeinstance | kind
... type S0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType S0..1CodeableConceptPhysical form of the location
... managingOrganization S1..1Reference(PCA Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Location.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status ?!SΣC1..1codeactive | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-pca-8: status shall be either 'active' or 'inactive'
... name SΣ1..1stringName of the location as used by humans
... mode SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... managingOrganization SΣ1..1Reference(PCA Organization)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location C0..*AUBaseLocationA location at which services are offered by a publisher
inv-pca-1: managingOrganization shall be a relative reference to an Organization
inv-pca-2: If present, the type must include either 'MOBL' or 'VI'
inv-pca-3: If type contains 'VI', no other type must be present
inv-pca-4: If type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
inv-pca-5: If type contains 'MOBL', then mode shall be 'kind'
inv-pca-6: If type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
inv-pca-7: Either type or address shall be present
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-amenity S0..*CodeableConceptPhysical features within or in close proximity of the location
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-amenity
Binding: PCA Amenity (required)
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AULocationSpecificPracticeNumber, AUNATASiteNumberUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:pca-li S0..1PcaLocationIdentifierPCA Location Identifier (PCA-LI) issued by the PCA service
... status ?!SΣC1..1codeactive | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.


inv-pca-8: status shall be either 'active' or 'inactive'
... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..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 SΣ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type SΣ0..*CodeableConceptType of function performed
Binding: PCA Service Delivery Location Role Type (required)
... telecom S0..*ContactPointContact details of the location
... address SC0..1AustralianAddressAddress at which services are offered by a publisher
inv-add-0: The address shall at least have text or a line
inv-add-1: If asserting no fixed address, the type shall be 'physical'
inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS'
inv-pca-9: At most, one DPID address identifier shall be present
inv-pca-10: At most, one G-NAF address identifier shall be present
inv-pca-11: address shall contain a maximum of 3 line elements
... physicalType SΣ0..1CodeableConceptPhysical form of the location
Binding: Location Type (Physical) - AU Extended (preferred)
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(PCA 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.typerequiredPcaServiceDeliveryLocationRoleType
http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-service-delivery-location-role-type
from this IG
Location.physicalTypepreferredLocationPhysicalTypeAUExtended
http://terminology.hl7.org.au/ValueSet/location-physical-type-extended
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-pca-1errorLocationmanagingOrganization shall be a relative reference to an Organization
: managingOrganization.reference.startsWith('Organization/')
inv-pca-2errorLocationIf present, the type must include either 'MOBL' or 'VI'
: type.exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() or type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists())
inv-pca-3errorLocationIf type contains 'VI', no other type must be present
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies (type.count() = 1)
inv-pca-4errorLocationIf type contains 'MOBL', it must also include at least one of the following codes to further qualify where the mobile service is offered: 'PTRES', 'SCHOOL', 'WORK', 'COMM' or 'AMB'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies (type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'PTRES').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'SCHOOL').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'WORK').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'COMM').exists() or type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'AMB').exists())
inv-pca-5errorLocationIf type contains 'MOBL', then mode shall be 'kind'
: type.coding.where(system='http://terminology.hl7.org/CodeSystem/v3-RoleCode' and code = 'MOBL').exists() implies mode.exists(value = 'kind')
inv-pca-6errorLocationIf type contains 'VI', then mode shall be 'kind' and physicalType shall be 'vi'
: type.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-type' and code = 'VI').exists() implies mode.exists(value = 'kind') and physicalType.coding.where(system='http://terminology.hl7.org.au/CodeSystem/location-physical-type' and code = 'vi')
inv-pca-7errorLocationEither type or address shall be present
: (type.exists() implies address.exists().not()) and (type.exists().not() implies address.exists())
inv-pca-8errorLocation.statusstatus shall be either 'active' or 'inactive'
: (value = 'active') or (value = 'inactive')
inv-pca-9errorLocation.addressAt most, one DPID address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/dpid').count() < 2
inv-pca-10errorLocation.addressAt most, one G-NAF address identifier shall be present
: extension('http://hl7.org.au/fhir/StructureDefinition/address-identifier').value.where(system='http://hl7.org.au/id/gnafidentifier').count() < 2
inv-pca-11errorLocation.addressaddress shall contain a maximum of 3 line elements
: line.count() < 4

This structure is derived from AUBaseLocation

Summary

Mandatory: 4 elements
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No additional search parameters defined for this resource profile.