Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-healthcareservice-core-1 | Version: 1.0.1 | |||
Active as of 2024-12-19 | Computable Name: ADHAHealthcareServiceCore | |||
Copyright/Legal: Copyright © 2022 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/. |
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 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:
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseHealthcareService
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 | SC | 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 | SC | 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 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) ele-1: All FHIR elements must have a @value or children inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
providedBy | SΣC | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) ele-1: All FHIR elements must have a @value or children |
specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) ele-1: All FHIR elements must have a @value or children |
location | SΣC | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children |
name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children |
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConceptshttp://terminology.hl7.org.au/ValueSet/service-provision-conditions |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
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.
| |||||
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 | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check | ||||
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: Service Type (preferred) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (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 Description (No ValueSet): (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 Description (No ValueSet): (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.
| |||||
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 |
Path | Conformance | ValueSet | URI | |||
HealthcareService.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConceptshttp://terminology.hl7.org.au/ValueSet/service-provision-conditions | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUBaseHealthcareService
Summary
Mandatory: 1 element
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AUBaseHealthcareService
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 | SC | 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 | SC | 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 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | C | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) ele-1: All FHIR elements must have a @value or children inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
providedBy | SΣC | 0..1 | Reference(ADHA Core Organization) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) ele-1: All FHIR elements must have a @value or children |
specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) ele-1: All FHIR elements must have a @value or children |
location | SΣC | 0..* | Reference(ADHA Core Location) | Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children |
name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children |
serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConceptshttp://terminology.hl7.org.au/ValueSet/service-provision-conditions |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
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.
| |||||
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 | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) inv-hpio-0: HPI-O shall be 16 digits inv-hpio-1: HPI-O prefix shall be 800362 inv-hpio-2: HPI-O shall pass the Luhn algorithm check | ||||
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: Service Type (preferred) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (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 Description (No ValueSet): (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 Description (No ValueSet): (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.
| |||||
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 |
Path | Conformance | ValueSet | URI | |||
HealthcareService.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConceptshttp://terminology.hl7.org.au/ValueSet/service-provision-conditions | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-heser-01 | error | HealthcareService | If present, the organization providing the service shall at least have a reference, an identifier or a display : providedBy.exists() implies providedBy.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-heser-02 | error | HealthcareService | If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) |
This structure is derived from AUBaseHealthcareService
Summary
Mandatory: 1 element
Must-Support: 9 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Core HealthcareService profile.