AU Core Implementation Guide
0.1.0-draft - Draft Australia flag

This page is part of the AU Core Implementation Guide 0.1.0 Draft. It is based on AU Base 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core HealthcareService

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice Version: 0.1.0-draft
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreHealthcareService

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

​This profile sets minimum expectations for a HealthcareService resource to record, search, and fetch information about a healthcare service. It is based on the AU Base Healthcare Service profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the HealthcareService when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for basic information for a healthcare service by name or identifier
  • Record or update basic information for a healthcare service
  • Read information about a healthcare service referenced by another resource

Profile specific implementation guidance

None.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... 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 S0..1Reference(AU Core Organization)Organization that provides this service
... type S0..*CodeableConceptType of service that may be delivered or performed
... specialty S0..*CodeableConceptSpecialties handled by the HealthcareService
... location S0..*Reference(AU 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 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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)
... providedBy SΣ0..1Reference(AU 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Σ0..*Reference(AU Core Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.categoryexampleServiceCategory
HealthcareService.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
HealthcareService.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditionsAustralianConcepts
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... 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Σ0..1Reference(AU 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Σ0..*Reference(AU 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

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

This structure is derived from AUBaseHealthcareService

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element HealthcareService.identifier is sliced based on the value of pattern:type

Maturity: 0

Differential View

This structure is derived from AUBaseHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... 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 S0..1Reference(AU Core Organization)Organization that provides this service
... type S0..*CodeableConceptType of service that may be delivered or performed
... specialty S0..*CodeableConceptSpecialties handled by the HealthcareService
... location S0..*Reference(AU 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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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)
... providedBy SΣ0..1Reference(AU 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Σ0..*Reference(AU Core Location)Location(s) where service may be provided
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.categoryexampleServiceCategory
HealthcareService.typepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
HealthcareService.specialtypreferredhttps://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditionsAustralianConcepts

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... 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Σ0..1Reference(AU 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Σ0..*Reference(AU 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

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

This structure is derived from AUBaseHealthcareService

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element HealthcareService.identifier is sliced based on the value of pattern:type

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
TBD TBD TBD TBD TBD

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported: