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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA 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 S0..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:type
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
... active 0..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy SC0..1Reference(ADHA Core Organization)Organization that provides this service
... category S0..*CodeableConceptBroad category of service being performed or delivered
... type S0..*CodeableConceptType of service that may be delivered or performed
... specialty S0..*CodeableConceptSpecialties handled by the HealthcareService
... location SC0..*Reference(ADHA Core Location)Location(s) where service may be provided
... name S1..1stringDescription of service as presented to a consumer while searching
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:type
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy SΣC0..1Reference(ADHA Core Organization)Organization that provides this service
... category SΣ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣC0..*Reference(ADHA Core Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... 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 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..*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 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... 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 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..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 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..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 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*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 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... 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 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 S0..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:type
.... identifier:hpio S0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
... active 0..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy SC0..1Reference(ADHA Core Organization)Organization that provides this service
... category S0..*CodeableConceptBroad category of service being performed or delivered
... type S0..*CodeableConceptType of service that may be delivered or performed
... specialty S0..*CodeableConceptSpecialties handled by the HealthcareService
... location SC0..*Reference(ADHA Core Location)Location(s) where service may be provided
... name S1..1stringDescription of service as presented to a consumer while searching
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C0..*AUBaseHealthcareServiceA 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:type
.... identifier:hpio SC0..1AUHPIOHealthcare Provider Identifier – Organisation (HPI-O)
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy SΣC0..1Reference(ADHA Core Organization)Organization that provides this service
... category SΣ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
... location SΣC0..*Reference(ADHA Core Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... 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 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..*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 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... 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 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..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 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..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 0..1CodeableConceptAU time zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*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 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... 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

 

Terminology Bindings

PathConformanceValueSet
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
HealthcareService.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditionsAustralianConcepts
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Search Parameters

None defined.