AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base HealthcareService

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 3 Computable Name: AUBaseHealthcareService

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

This profile defines a healthcare service structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • An HPI-O can be sent in HealthcareService.identifier when supporting the case where network HPI-Os are issued for sub-organisations, departments, or other logical divisions acting as specific healthcare services. This is useful in the absence of any specific national identifier for healthcare service entities.
  • See each Identifier profile page for guidance related to that identifier type.
  • If a system needs to differentiate contacts for a practitioner in a role by purpose:
    • contact information is sent in HealthcareService.telecom
    • purpose for the contact is sent using the Contact Purpose extension in HealthcareService.telecom.extension
  • See the AU Base Location profile for guidance on using a Location resource as part of defining a type of mobile or remotely delivered service.
  • When populating available times for a health care service, e.g. HealthcareService.availableTime.availableStartTime, an Australian time zone offset is represented using the Timezone Code extension as profiled by Australian Time Zone Usage.

Potentially useful extensions:

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed (HealthcareService.availableTime.availableStartTime.extension:timeZone)
  • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    HealthcareService.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHPIO The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUResidentialAgedCareServiceIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well External identifiers for this item
    HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
    HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error HealthcareService 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from HealthcareService

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.identifier 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    HealthcareService.type 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)
    HealthcareService.availableTime
    HealthcareService.availableTime.availableStartTime
    HealthcareService.availableTime.availableStartTime.Slices for extension Content/Rules for all slices
    HealthcareService.availableTime.availableStartTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableEndTime
    HealthcareService.availableTime.availableEndTime.Slices for extension Content/Rules for all slices
    HealthcareService.availableTime.availableEndTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
    HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    HealthcareService.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    HealthcareService.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    HealthcareService.contained 0..* Resource Contained, inline Resources
    HealthcareService.extension 0..* Extension Additional content defined by implementations
    HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    HealthcareService.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHPIO The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUResidentialAgedCareServiceIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well External identifiers for this item
    HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
    HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
    HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
    Binding: ServiceCategory (example): A category of the service(s) that could be provided.
    HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.location This element is included in summaries. 0..* Reference(Location) Location(s) where service may be provided
    HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
    HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
    HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
    HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
    HealthcareService.telecom 0..* ContactPoint Contacts related to the healthcare service
    HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
    HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
    HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
    HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
    HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
    Binding Description: (example): Coded values underwhich a specific service is made available.
    HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
    HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
    Binding: Program (example): Government or local programs that this service applies to.
    HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
    Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)
    HealthcareService.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.
    HealthcareService.appointmentRequired 0..1 boolean If an appointment is required for access to this service
    HealthcareService.availableTime 0..* BackboneElement Times the Service Site is available
    HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
    HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
    HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
    HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
    HealthcareService.availableTime.availableStartTime.id 0..1 string xml:id (or equivalent in JSON)
    HealthcareService.availableTime.availableStartTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    HealthcareService.availableTime.availableStartTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableStartTime.value 0..1 time Primitive value for time
    HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
    HealthcareService.availableTime.availableEndTime.id 0..1 string xml:id (or equivalent in JSON)
    HealthcareService.availableTime.availableEndTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    HealthcareService.availableTime.availableEndTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableEndTime.value 0..1 time Primitive value for time
    HealthcareService.notAvailable 0..* BackboneElement Not available during this time due to provided reason
    HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
    HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
    HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
    HealthcareService.notAvailable.during 0..1 Period Service not available from this date
    HealthcareService.availabilityExceptions 0..1 string Description of availability exceptions
    HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.eligibility.​code Base example Not State Unknown
    HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
    HealthcareService.characteristic Base example Not State Unknown
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
    HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
    HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error HealthcareService 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from HealthcareService

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 3

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    HealthcareService.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHPIO The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUResidentialAgedCareServiceIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well External identifiers for this item
    HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
    HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error HealthcareService 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Differential View

    This structure is derived from HealthcareService

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.identifier 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    HealthcareService.type 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)
    HealthcareService.availableTime
    HealthcareService.availableTime.availableStartTime
    HealthcareService.availableTime.availableStartTime.Slices for extension Content/Rules for all slices
    HealthcareService.availableTime.availableStartTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableEndTime
    HealthcareService.availableTime.availableEndTime.Slices for extension Content/Rules for all slices
    HealthcareService.availableTime.availableEndTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    HealthcareService 0..* HealthcareService A healthcare service in an Australian healthcare context
    HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
    HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    HealthcareService.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    HealthcareService.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    HealthcareService.contained 0..* Resource Contained, inline Resources
    HealthcareService.extension 0..* Extension Additional content defined by implementations
    HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    HealthcareService.identifier This element is included in summaries. 0..* Identifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUHPIO The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well, AUResidentialAgedCareServiceIdentifier The constraints on the root of this type profile have not been applied to this element in the snapshot. Check the type profile directly as well External identifiers for this item
    HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
    HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
    HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
    Binding: ServiceCategory (example): A category of the service(s) that could be provided.
    HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type (preferred)
    HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty (preferred)
    HealthcareService.location This element is included in summaries. 0..* Reference(Location) Location(s) where service may be provided
    HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
    HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
    HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
    HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
    HealthcareService.telecom 0..* ContactPoint Contacts related to the healthcare service
    HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
    HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
    HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
    HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
    HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
    Binding Description: (example): Coded values underwhich a specific service is made available.
    HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
    HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
    Binding: Program (example): Government or local programs that this service applies to.
    HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
    Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
    HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
    Binding: Common Languages in Australia (extensible)
    HealthcareService.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.
    HealthcareService.appointmentRequired 0..1 boolean If an appointment is required for access to this service
    HealthcareService.availableTime 0..* BackboneElement Times the Service Site is available
    HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
    HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
    HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
    Binding: DaysOfWeek (required): The days of the week.
    HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
    HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
    HealthcareService.availableTime.availableStartTime.id 0..1 string xml:id (or equivalent in JSON)
    HealthcareService.availableTime.availableStartTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    HealthcareService.availableTime.availableStartTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableStartTime.value 0..1 time Primitive value for time
    HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
    HealthcareService.availableTime.availableEndTime.id 0..1 string xml:id (or equivalent in JSON)
    HealthcareService.availableTime.availableEndTime.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    HealthcareService.availableTime.availableEndTime.Slices for extension.extension:timeZone 0..1 code IANA Timezone Code per BCP 175
    URL: http://hl7.org/fhir/StructureDefinition/timezone
    Binding: IANATimezones (required): IANA Timezones (BCP 175)
    HealthcareService.availableTime.availableEndTime.value 0..1 time Primitive value for time
    HealthcareService.notAvailable 0..* BackboneElement Not available during this time due to provided reason
    HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
    HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
    HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
    HealthcareService.notAvailable.during 0..1 Period Service not available from this date
    HealthcareService.availabilityExceptions 0..1 string Description of availability exceptions
    HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
    HealthcareService.type Base preferred Service Type ⏿1.0.0 tx.hl7.org.au
    HealthcareService.specialty Base preferred Clinical Specialty ⏿1.1.0 tx.hl7.org.au
    HealthcareService.serviceProvisionCode Base preferred Service Provision Conditions Australian Concepts 📦7.0.0-ci-build This IG
    HealthcareService.eligibility.​code Base example Not State Unknown
    HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
    HealthcareService.characteristic Base example Not State Unknown
    HealthcareService.communication Base extensible Common Languages in Australia ⏿2.2.1 tx.hl7.org.au
    HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
    HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
    dom-3 error HealthcareService 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5 error HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
    dom-6 best practice HealthcareService A resource should have narrative for robust management text.`div`.exists()
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from HealthcareService

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron