| Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

### StructureDefinition: ADHA Core HealthcareService [Active]

The purpose of this profile is to define a core representation of a healthcare service for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. In the context of an exchange of health information a healthcare service is part of the context established for a set of healthcare-related information.

This profile identifies the additional constraints, extensions, and value sets that build on and extend HealthcareService that are supported.

A HealthcareService resource is used within the context of a referencing resource.

This profile is designed to set a core HealthcareService standard for:

- Recording or updating a healthcare service referenced by another resource
- Reading healthcare services referenced by another resource

#### Profile specific guidance

None.

#### Boundaries and relationships

This profile is referenced by ADHA Authoring PractitionerRole and ADHA Core PractitionerRole.

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-healthcareservice-core-1

The purpose of this profile is to provide a core representation of a healthcare service for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on AUBaseHealthcareService.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

- Differential Table
- Snapshot Table
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context inv-dh-heser-01: If present, the organization providing the service shall at least have a reference, an identifier or a display inv-dh-heser-02: If present, a location shall at least have a reference, an identifier or a display
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type
identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O)
active |  | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | S C | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service
category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered
type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed
specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService
location | S C | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided
name | S | 1..1 | string | Description of service as presented to a consumer while searching
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context inv-dh-heser-01: If present, the organization providing the service shall at least have a reference, an identifier or a display inv-dh-heser-02: If present, a location shall at least have a reference, an identifier or a display
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type
identifier:hpio | S C | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O)
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | S Σ C | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service
category | S Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
location | S Σ C | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | Σ | 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 |  | 0..* | ContactPoint | Contacts related to the healthcare service
coverageArea |  | 0..* | Reference(Location) | Location(s) service is intended for/available to
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred)
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)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
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

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context inv-dh-heser-01: If present, the organization providing the service shall at least have a reference, an identifier or a display inv-dh-heser-02: If present, a location shall at least have a reference, an identifier or a display
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type
identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O)
active |  | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | S C | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service
category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered
type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed
specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService
location | S C | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided
name | S | 1..1 | string | Description of service as presented to a consumer while searching
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context inv-dh-heser-01: If present, the organization providing the service shall at least have a reference, an identifier or a display inv-dh-heser-02: If present, a location shall at least have a reference, an identifier or a display
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type
identifier:hpio | S C | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O)
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | S Σ C | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service
category | S Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
location | S Σ C | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | Σ | 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 |  | 0..* | ContactPoint | Contacts related to the healthcare service
coverageArea |  | 0..* | Reference(Location) | Location(s) service is intended for/available to
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred)
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)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
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

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

#### Terminology Bindings

Path | Conformance | ValueSet
HealthcareService.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.category | example | ServiceCategory
HealthcareService.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
HealthcareService.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program
HealthcareService.characteristic | example |
HealthcareService.communication | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.referralMethod | example | ReferralMethod
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek

#### Search Parameters

None defined.