Provider Connect Australia (PCA)
2.4.2 - active

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

## Resource Profile: PCA Partner Service

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service | Version: 2.4.2
Active as of 2024-03-19 | Computable Name: PcaPartnerService
Copyright/Legal: Copyright © 2023 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 HealthcareService defines a PCA Partner Service. A PCA Partner Service is a service offered by a PCA subscriber to which PCA publishers can publish their service offerings (i.e. Healthcare Service).

### Must support

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

### Extensions

Extensions introduced in this profile:

- HealthcareService: PCA Current Information Use Statement
- HealthcareService.telecom: PCA Description

### Supported interactions

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

- For publishing systems: PCA Publisher Agent
- For subscribing systems: PCA Subscriber Agent

Usage:

- Refer to this Resource Profile: PCA Bank Account, PCA Information Use Statement, PCA Match Record and PCA Publication Authorisation Record

### Formal Views of Profile Content

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

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

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S | 0..1 | id | Logical id of this artifact
meta | S | 0..1 | Meta | Metadata about the resource
versionId | S | 0..1 | id | Version specific identifier
lastUpdated | S | 0..1 | instant | When the resource version last changed
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
Slices for identifier | S | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | S | 1..1 | boolean | Whether this partner service is in active use
providedBy | S | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
name | S | 1..1 | string | Description of service as presented to a consumer while searching
comment | S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
telecom | S | 0..* | ContactPoint | Website for this service
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url
value |  | 1..1 | string | The actual contact point details
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
id |  | 0..0 |  |
extension |  | 0..0 |  |
reference |  | 0..0 |  |
type |  | 0..0 |  |
identifier |  | 0..0 |  |
display |  | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
versionId | S Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource version last changed
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | ?!S Σ | 1..1 | boolean | Whether this partner service is in active use
providedBy | S Σ | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | S Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
telecom | S | 0..* | ContactPoint | Website for this service
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url
value | Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
extension |  | 0..0 |  |
display | Σ | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG
HealthcareService.telecom.system | required | Fixed Value: url `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
HealthcareService.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | S Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | ?!S Σ | 1..1 | boolean | Whether this partner service is in active use
providedBy | S Σ | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | S Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
extraDetails |  | 0..1 | markdown | Extra details about the service that can't be placed in the other fields
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service
telecom | S | 0..* | ContactPoint | Website for this service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url
value | Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
extension |  | 0..0 |  |
display | Σ | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication |  | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired |  | 0..1 | boolean | If an appointment is required for access to this service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
HealthcareService.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
HealthcareService.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags` from the FHIR Standard
HealthcareService.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG
HealthcareService.type | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
HealthcareService.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
HealthcareService.telecom.system | required | Fixed Value: url `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
HealthcareService.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions `http://hl7.org/fhir/ValueSet/service-provision-conditions` from the FHIR Standard
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program` from the FHIR Standard
HealthcareService.characteristic | example |
HealthcareService.communication | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
HealthcareService.referralMethod | example | ReferralMethod `http://hl7.org/fhir/ValueSet/service-referral-method` from the FHIR Standard
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

This structure is derived from HealthcareService

Summary

Mandatory: 6 elements (3 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

- PCA Partner Service Identifier (PCA-PSI) (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service-identifier)
- PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)

Extensions

This structure refers to these extensions:

- http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
- http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description

Slices

This structure defines the following Slices:

- The element HealthcareService.identifier is sliced based on the value of value:system

Differential View

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S | 0..1 | id | Logical id of this artifact
meta | S | 0..1 | Meta | Metadata about the resource
versionId | S | 0..1 | id | Version specific identifier
lastUpdated | S | 0..1 | instant | When the resource version last changed
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
Slices for identifier | S | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | S | 1..1 | boolean | Whether this partner service is in active use
providedBy | S | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
name | S | 1..1 | string | Description of service as presented to a consumer while searching
comment | S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
telecom | S | 0..* | ContactPoint | Website for this service
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url
value |  | 1..1 | string | The actual contact point details
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
id |  | 0..0 |  |
extension |  | 0..0 |  |
reference |  | 0..0 |  |
type |  | 0..0 |  |
identifier |  | 0..0 |  |
display |  | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
versionId | S Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource version last changed
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | ?!S Σ | 1..1 | boolean | Whether this partner service is in active use
providedBy | S Σ | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | S Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
telecom | S | 0..* | ContactPoint | Website for this service
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url
value | Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
extension |  | 0..0 |  |
display | Σ | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG
HealthcareService.telecom.system | required | Fixed Value: url `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
HealthcareService.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | HealthcareService | A service offered by a subscriber to which a publisher can publish their own service offerings inv-pca-1: providedBy shall be a relative reference to an Organization inv-pca-2: coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits
id | S Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | S Σ | 0..1 | id | Version specific identifier
lastUpdated | S Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
pca-current-information-use-statement | S | 1..1 | Reference(PCA Information Use Statement) | Reference to the current Information Use Statement of this Partner Service URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 0..* | Identifier | External identifiers for this item Slice: Unordered, Open by value:system
identifier:pca-psi | S | 0..1 | PcaPartnerServiceIdentifier | PCA Partner Service Identifier (PCA-PSI)
active | ?!S Σ | 1..1 | boolean | Whether this partner service is in active use
providedBy | S Σ | 1..1 | Reference(PCA Organization) | Organization that provides this partner service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: PCA Partner Service Category (required): The type of the partner service.
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | S Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
extraDetails |  | 0..1 | markdown | Extra details about the service that can't be placed in the other fields
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service
telecom | S | 0..* | ContactPoint | Website for this service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
description | S | 0..1 | string | Description of element or resource URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url
value | Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
coverageArea | S | 0..* | Reference(Location) | Location(s) service is intended for/available to
extension |  | 0..0 |  |
display | Σ | 1..1 | string | Text alternative for the resource Example Brisbane area postcode: 40
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication |  | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired |  | 0..1 | boolean | If an appointment is required for access to this service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
HealthcareService.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
HealthcareService.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags` from the FHIR Standard
HealthcareService.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
HealthcareService.category | required | PcaPartnerServiceCategory (a valid code from PCA Partner Service Category) `http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-partner-service-category` from this IG
HealthcareService.type | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
HealthcareService.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
HealthcareService.telecom.system | required | Fixed Value: url `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
HealthcareService.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions `http://hl7.org/fhir/ValueSet/service-provision-conditions` from the FHIR Standard
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program` from the FHIR Standard
HealthcareService.characteristic | example |
HealthcareService.communication | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
HealthcareService.referralMethod | example | ReferralMethod `http://hl7.org/fhir/ValueSet/service-referral-method` from the FHIR Standard
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-pca-1 | error | HealthcareService | providedBy shall be a relative reference to an Organization : providedBy.reference.startsWith('Organization/') |
inv-pca-2 | error | HealthcareService | coverageArea shall have a display string representing the postcode or postcode range of the area as a single value with one to four digits : coverageArea.exists() implies coverageArea.all(display.value.matches('^[0-9]{1,4}$')) |

This structure is derived from HealthcareService

Summary

Mandatory: 6 elements (3 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 1 element
Prohibited: 5 elements

Structures

This structure refers to these other structures:

- PCA Partner Service Identifier (PCA-PSI) (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service-identifier)
- PCA Organization (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-organization)

Extensions

This structure refers to these extensions:

- http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-current-information-use-statement
- http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-description

Slices

This structure defines the following Slices:

- The element HealthcareService.identifier is sliced based on the value of value:system

Other representations of profile: CSV, Excel, Schematron

### Notes:

Additional search parameters defined for this resource profile:

Name | Type | Description | Expression | In Common
--- | --- | --- | --- | ---
coverage-area.location.address-postalcode | string | Postal code of location(s) that this service is intended for/available to | HealthcareService.coverageArea.address.postalCode |