Provider Connect Australia (PCA) FHIR Implementation Guide 2.4.0

This is release 2.4.0 of Provider Connect Australia (PCA) FHIR Implementation Guide. It is based on FHIR version 4.0.1. See the Directory of published versions.

SD.8 StructureDefinition-pca-healthcare-service [Draft]

PCA Healthcare Service

This profile of HealthcareService defines a PCA Healthcare Service. A PCA Healthcare Service is a service offered at a location by a PCA publishing organisation.

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-hsi elements: publishing systems creating a new PCA Healthcare Service 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 Healthcare Service resource shall not provide these elements. These values are generated by the PCA service.
  • For the type element: a publishing system is required to provide a single code that represents the primary service type (by using the ‘iso21090-preferred’ extension). Any other values for the type element will be ignored.
  • For the comment element: a publishing system may only provide this element (and a subscribing system will only receive this element) if the type element includes the ‘COVID-19 Vaccination Service’ (1575161000168105) code. Please note that use of the ‘COVID-19 Vaccination Service’ service type will be permitted in a future release of PCA.
  • For the active element: publishing systems creating or updating a PCA Healthcare Service resource shall not provide this element. This value is calculated by the PCA service at the time the PCA Healthcare Service resource is provided to a subscribing system, using the period defined in the pca-active-period extension. See the ‘PCA Active Period’ section in the usage notes below for more information.
  • For the pca-bank-account extension: any values provided by publishing systems when adding or updating a PCA Healthcare Service will be ignored by the PCA service. Bank account details must be managed by a healthcare provider organisation via the PCA Portal. The PCA service will populate the extension when providing the PCA Healthcare Service resource to subscribing systems.

Extensions

Extensions introduced in this profile:

Usage notes

Identifiers

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

  • PCA Healthcare Service Identifier (PCA-HSI)

A PCA Healthcare Service 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 Healthcare Service.

Active and PCA Active Period

The pca-active-period extension is used to indicate the period when the healthcare service is active. It is used by the PCA service to set the value of the active element:

  • If the pca-active-period extension is present, the PCA service will set the active value based on the extension’s start and/or end elements.
  • If the pca-active-period extension is not present, the PCA service will set the active value to ‘true’.

The active element is used by the PCA service to set the active element of practitoner roles that reference the healthcare service:

  • If the PCA service sets the active element to ‘false’, then the active element of all practitoner roles that reference the healthcare service will also be set to ‘false’ by the PCA service, regardless of the value of the practitoner role’s period element.
  • If the PCA service sets the active element to ‘true’, then the active element of all practitoner roles that reference the healthcare service will be calculated based on their period value. See the Usage notes of the PCA Practitioner Role profile for more information.

In addition to the invariants defined in this profile, the PCA service applies the following additional validation rules for pca-active-period:

  • If present, pca-active-period.value[x].start SHALL be equal to, or earlier than, the period.start or period.end values of any PractitionerRole resources that reference this HealthcareService.
  • If present, pca-active-period.value[x].end SHALL be equal to, or later than, the period.start or period.end values of any PractitionerRole resources that reference this HealthcareService.
Organisation reference

The providedBy 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 healthcare service has been created, the providedBy element cannot be changed to reference a different organisation.

Service type

To indicate the primary service type of the healthcare service, use the iso21090-preferred extension on the type element.

When a healthcare service is provided to a subscribing system the values for the type element are populated with the primary service type (through the presence of the ‘iso21090-preferred’ extension), as well as any parent terms of the primary service type in the SNOMED hierarchy, up to but not including direct descendants of 224930009 (Services).

Please note that use of the ‘COVID-19 Vaccination Service’ (1575161000168105) service type will be permitted in a future release of PCA.

Location reference

The location element must contain a relative reference to an existing PCA Location whose managingOrganization references the same PCA Organization as is referenced by the providedBy element. Publishing systems can create new locations or search for existing locations using the PCA Publisher Agent API. After a healthcare service has been created, the location element cannot be changed to reference a different location.

Availability

To indicate a change in the pattern of availability of the healthcare service during a particular period, use availableTime with the availableTimeApplicability extension.

To indicate the healthcare service is not available during a period of time, use notAvailable.

An availableTime using the availableTimeApplicability modifierExtension overrides any other availableTime that contains the same day(s), for the period defined in the during element.

Coverage area

The coverage area that a service is intended for/available to should be defined using one or more instances of the coverageArea element, with the address elements of the contained Location populated depending on the type of coverage area to be defined. PCA currently supports coverage areas to be defined as Australia-wide (in which case only one coverageArea element should be present), or as a combination of individual states and/or suburbs (with separate coverageArea elements for each). See the PCA Service Coverage Area profile for more information.

The coverageArea element shall only be present when eligibility contains ‘coverage-restrictedResidents’, and/or the type of the referenced location is ‘MOB’ (mobile) or ‘VI’ (virtual).

Referral information

Some subscribing systems may render markdown contained in the PCA Referral Information For Provider and PCA Referral Information For Consumer elements; however this is not guaranteed, so publishing systems should limit markdown syntax in these elements to that which still renders well as plain text (such as bullets, numbered lists, or bold/italic text).

Address lines

When a PCA Healthcare Service 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) are processed/populated by PCA using the rules that are defined in the usage notes of the PCA Postal Address extension.

Supported interactions

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


SD.8.1 Formal views of profile content

The official URL for this profile is: 

http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-healthcare-service

This profile of HealthcareService defines a PCA Healthcare Service. A PCA Healthcare Service is a service offered at a location by a PCA publisher.

This profile builds on AUBaseHealthcareService.

This profile was published on 2023-09-15 10:45:26+1000 as a draft by Australian Digital Health Agency.

Description of profiles, differentials, snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA service offered by a publisher
inv-pca-1: telecom use shall not be 'home'
inv-pca-2: providedBy shall be a relative reference to an Organization
inv-pca-3: location shall be a relative reference to a Location
inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present
inv-pca-5: exactly one type shall be preferred
inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements
inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
inv-pca-8: If type does not contain 'COVID-19 Vaccination Service’ (1575161000168105), then comment shall not 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
... contained S0..*PcaServiceCoverageAreaContained inline pca-service-coverage-area resource
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... pca-referral-information-for-consumer S0..1markdownReferral instructions and information for consumers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
... pca-referral-information-for-provider S0..1markdownReferral instructions and information for providers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
... pca-active-period S0..1PeriodPeriod when the healthcare service is active
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... Slices for identifier S1..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-hsi S0..1PcaHealthcareServiceIdentifierPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
... active S1..1booleanWhether this HealthcareService record is in active use
... providedBy S1..1Reference(PCA Organization)Organization that provides this service
... type S1..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (required)
.... preferred S0..1booleanWhether this is the primary service type for this HealthcareService
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... location S1..1Reference(PCA Location)Location where service is provided
... name S1..1stringDescription of service as presented to a consumer while searching
... comment SC0..1stringAdditional description and/or any specific issues not covered elsewhere
inv-pca-9: If present, comment shall be a maximum of 500 characters
... telecom S0..*ContactPointContacts related to the healthcare service
.... contactPurpose S0..*CodeableConceptContact purpose
URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose
Binding: Contact Purpose (extensible)
... coverageArea S0..*Reference(PCA Service Coverage Area) {c}Location(s) service is intended for/available to
... serviceProvisionCode S1..1CodeableConceptCondition under which this service is available/offered
Binding: Service Provision Conditions Australian Concepts (required)
... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... code S1..1CodeableConceptCoded value for the eligibility
Binding: PCA Eligibility (required)
... communication S0..*CodeableConceptThe language that this service is offered in
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: PCA Referral Method (required)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SC0..*BackboneElementTimes the Service Site is available
inv-pca-10: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present
inv-pca-11: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
.... modifierExtension:availableTimeApplicability S0..1PcaAvailableTimeApplicabilityIndicates the period and reason that this instance of availableTime applies
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
..... extension:timeZone S0..1AustralianTimeZoneAU time zone
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
..... extension:timeZone S0..1AustralianTimeZoneAU time zone
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodDate range that the service is not available - can be open-ended if service is closing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA service offered by a publisher
inv-pca-1: telecom use shall not be 'home'
inv-pca-2: providedBy shall be a relative reference to an Organization
inv-pca-3: location shall be a relative reference to a Location
inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present
inv-pca-5: exactly one type shall be preferred
inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements
inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
inv-pca-8: If type does not contain 'COVID-19 Vaccination Service’ (1575161000168105), then comment shall not 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 S0..*PcaServiceCoverageAreaContained inline pca-service-coverage-area resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... pca-referral-information-for-consumer S0..1markdownReferral instructions and information for consumers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
... pca-referral-information-for-provider S0..1markdownReferral instructions and information for providers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
... pca-active-period S0..1PeriodPeriod when the healthcare service is active
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-hsi S0..1PcaHealthcareServiceIdentifierPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣ1..1Reference(PCA Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ1..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... preferred S0..1booleanWhether this is the primary service type for this HealthcareService
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ1..1Reference(PCA Location)Location where service is provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment SΣC0..1stringAdditional description and/or any specific issues not covered elsewhere
inv-pca-9: If present, comment shall be a maximum of 500 characters
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactPurpose S0..*CodeableConceptContact purpose
URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose
Binding: Contact Purpose (extensible)
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(PCA Service Coverage Area) {c}Location(s) service is intended for/available to
... serviceProvisionCode S1..1CodeableConceptCondition under which this service is available/offered
Binding: Service Provision Conditions Australian Concepts (required)
... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... 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
.... code S1..1CodeableConceptCoded value for the eligibility
Binding: PCA Eligibility (required)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: PCA Referral Method (required)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SC0..*BackboneElementTimes the Service Site is available
inv-pca-10: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present
inv-pca-11: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... Slices for modifierExtension ?!Σ0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension:availableTimeApplicability ?!S0..1PcaAvailableTimeApplicabilityIndicates the period and reason that this instance of availableTime applies
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone S0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone S0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... 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
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodDate range that the service is not available - can be open-ended if service is closing
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Differential view

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA service offered by a publisher
inv-pca-1: telecom use shall not be 'home'
inv-pca-2: providedBy shall be a relative reference to an Organization
inv-pca-3: location shall be a relative reference to a Location
inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present
inv-pca-5: exactly one type shall be preferred
inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements
inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
inv-pca-8: If type does not contain 'COVID-19 Vaccination Service’ (1575161000168105), then comment shall not 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
... contained S0..*PcaServiceCoverageAreaContained inline pca-service-coverage-area resource
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... pca-referral-information-for-consumer S0..1markdownReferral instructions and information for consumers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
... pca-referral-information-for-provider S0..1markdownReferral instructions and information for providers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
... pca-active-period S0..1PeriodPeriod when the healthcare service is active
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... Slices for identifier S1..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-hsi S0..1PcaHealthcareServiceIdentifierPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
... active S1..1booleanWhether this HealthcareService record is in active use
... providedBy S1..1Reference(PCA Organization)Organization that provides this service
... type S1..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (required)
.... preferred S0..1booleanWhether this is the primary service type for this HealthcareService
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... location S1..1Reference(PCA Location)Location where service is provided
... name S1..1stringDescription of service as presented to a consumer while searching
... comment SC0..1stringAdditional description and/or any specific issues not covered elsewhere
inv-pca-9: If present, comment shall be a maximum of 500 characters
... telecom S0..*ContactPointContacts related to the healthcare service
.... contactPurpose S0..*CodeableConceptContact purpose
URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose
Binding: Contact Purpose (extensible)
... coverageArea S0..*Reference(PCA Service Coverage Area) {c}Location(s) service is intended for/available to
... serviceProvisionCode S1..1CodeableConceptCondition under which this service is available/offered
Binding: Service Provision Conditions Australian Concepts (required)
... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... code S1..1CodeableConceptCoded value for the eligibility
Binding: PCA Eligibility (required)
... communication S0..*CodeableConceptThe language that this service is offered in
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: PCA Referral Method (required)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SC0..*BackboneElementTimes the Service Site is available
inv-pca-10: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present
inv-pca-11: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
.... modifierExtension:availableTimeApplicability S0..1PcaAvailableTimeApplicabilityIndicates the period and reason that this instance of availableTime applies
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
..... extension:timeZone S0..1AustralianTimeZoneAU time zone
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
..... extension:timeZone S0..1AustralianTimeZoneAU time zone
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodDate range that the service is not available - can be open-ended if service is closing

doco Documentation for this format

Snapshot view

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA service offered by a publisher
inv-pca-1: telecom use shall not be 'home'
inv-pca-2: providedBy shall be a relative reference to an Organization
inv-pca-3: location shall be a relative reference to a Location
inv-pca-4: If eligibility contains 'coverage-restrictedResidents', then coverageArea shall be present
inv-pca-5: exactly one type shall be preferred
inv-pca-6: If present, au-timezone shall be the same as all other au-timezone codes that are present within all availableTime elements
inv-pca-7: If one or more availableTime elements using the availableTimeApplicability extension are present, then at least one availableTime (without the availableTimeApplicability extension) shall be present
inv-pca-8: If type does not contain 'COVID-19 Vaccination Service’ (1575161000168105), then comment shall not 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 S0..*PcaServiceCoverageAreaContained inline pca-service-coverage-area resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-postal-address S0..1AustralianAddressPostal address
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-postal-address
... pca-referral-information-for-consumer S0..1markdownReferral instructions and information for consumers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-consumer
... pca-referral-information-for-provider S0..1markdownReferral instructions and information for providers
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-referral-information-for-provider
... pca-active-period S0..1PeriodPeriod when the healthcare service is active
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-period
... pca-bank-account S0..*(Complex)Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system
.... identifier:pca-hsi S0..1PcaHealthcareServiceIdentifierPCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣ1..1Reference(PCA Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ1..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... preferred S0..1booleanWhether this is the primary service type for this HealthcareService
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣ1..1Reference(PCA Location)Location where service is provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment SΣC0..1stringAdditional description and/or any specific issues not covered elsewhere
inv-pca-9: If present, comment shall be a maximum of 500 characters
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactPurpose S0..*CodeableConceptContact purpose
URL: http://hl7.org.au/fhir/StructureDefinition/contact-purpose
Binding: Contact Purpose (extensible)
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(PCA Service Coverage Area) {c}Location(s) service is intended for/available to
... serviceProvisionCode S1..1CodeableConceptCondition under which this service is available/offered
Binding: Service Provision Conditions Australian Concepts (required)
... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... 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
.... code S1..1CodeableConceptCoded value for the eligibility
Binding: PCA Eligibility (required)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required)
... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: PCA Referral Method (required)
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime SC0..*BackboneElementTimes the Service Site is available
inv-pca-10: If an availableTime uses the availableTimeApplicability extension, then daysOfWeek shall not be present
inv-pca-11: If an availableTime does not use the availableTimeApplicability extension, then daysOfWeek shall be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... Slices for modifierExtension ?!Σ0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension:availableTimeApplicability ?!S0..1PcaAvailableTimeApplicabilityIndicates the period and reason that this instance of availableTime applies
.... daysOfWeek S0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime S0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone S0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime S0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... timeZone S0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... 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
.... description S1..1stringReason presented to the user explaining why time not available
.... during S0..1PeriodDate range that the service is not available - can be open-ended if service is closing
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

 

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.8.2 - Search parameters

No additional search parameters defined for this resource profile.

 

SD.8.3 - Known issues

No known issues.