AU Core Implementation Guide
0.2.2-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. 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.2.2-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreHealthcareService

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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

Comparison with other national and international specifications

No equivalent International Patient Access, International Patient Summary, or US Core profile.

Profile specific implementation guidance

  • When constructing an address
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile

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
Binding: Service Provision Conditions Australian Concepts (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
HealthcareService.serviceProvisionCodeextensibleServiceProvisionConditionsAustralianConcepts

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
name SHALL string
service-category SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
identifier SHOULD token The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both.

The client SHOULD support search using HPI-O identifier as defined in the profile. The server SHOULD support search using the using HPI-O identifier as defined in the profile.
location SHOULD reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
organization SHOULD reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
specialty SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
service-type SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters

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

  1. SHALL support searching for a healthcare service based on text name using the name search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?name=[string]

    Example:

    1. GET [base]/HealthcareService?name=Hospital

    Implementation Notes: Fetches a bundle of all HealthcareService resources matching the name (how to search by string)

Optional Search Parameters

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

  1. SHOULD support searching using a healthcare service using the service-category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?service-category={system|}[code]

    Example:

    1. GET [base]/HealthcareService?service-category=http://snomed.info/sct|708175003

    Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified service category (how to search by token)

  2. SHOULD support searching a healthcare service by an identifier using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?identifier={system|}[code]

    Example:

    1. GET [base]/HealthcareService?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455
    2. GET [base]/HealthcareService?identifier=http://ns.electronichealth.net.au/id/residential-aged-care-service-id|0009

    Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)

  3. SHOULD support searching using the location search parameters:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?location={Type/}[id]

    Example:

    1. GET [base]/HealthcareService?location=Location/Hospital

    Implementation Notes: Fetches a bundle of all HealthcareService resources matching the specified location (how to search by reference)

  4. SHOULD support searching using the organization search parameters:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?organization={Type/}[id]

    Example:

    1. GET [base]/HealthcareService?organization=Organization/Hospital

    Implementation Notes: Fetches a bundle of all HealthcareService resources matching the specified organisation (how to search by reference)

  5. SHOULD support searching using a healthcare service using the specialty search parameters:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?specialty={system|}[code]

    Example:

    1. GET [base]/HealthcareService?specialty=http://snomed.info/sct|394579002
    2. GET [base]/HealthcareService?specialty=http://snomed.info/sct|394579002&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified specialty (how to search by token)

  6. SHOULD support searching using a healthcare service using the service-type search parameters:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/HealthcareService?service-type={system|}[code]

    Example:

    1. GET [base]/HealthcareService?service-type=http://snomed.info/sct|708172000

    Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified type (how to search by token)