Smart Health Checks
0.3.0 - ci-build Australia flag

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

ActorDefinition: SHC Host FHIR Server

Official URL: https://smartforms.csiro.au/ig/ActorDefinition/SHCHostFHIRServer Version: 0.3.0
Draft as of 2025-09-23 Computable Name: SHCHostFHIRServer

Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

The SHC Host FHIR Server allows the SHC App to retrieve patient health information and writeback collected health check data.

Actor: SHCHostFHIRServer SHC Host FHIR ServerType: system

The SHC Host FHIR Server:

  • SHALL respond to SMART Authorization Configuration request
  • SHALL authorise FHIR API requests using Bearer access token per SMART APP Launch Access FHIR API
  • SHALL respond to read Practitioner request
  • SHALL respond to read Patient request
  • SHALL respond to search QuestionnaireResponse request
  • SHALL respond to read QuestionnaireResponse request
  • SHALL respond to create and update QuestionnaireResponse requests
  • SHALL respond to search and read requests for resources required by this IG
  • SHALL respond to create and patch requests in a transaction Bundle for resources required by this IG
Capabilities:SHC Host FHIR Server
Derived from:http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder

Notes:

SHC Host FHIR Server Interactions

SMART Authorization Configuration

The Health Check App uses the iss parameter provided in the launch request as the base URL of the PMS FHIR API to retrieve the PMS Authorization Server configuration from the .well-known/smart-configuration endpoint. The response provides, amongst other configuration elements, the authorization_endpoint and token_endpoint URLs required in the subsequent steps.

Prepopulate Health Check

The Health Check APP uses the access_token as the Authorization for any request to the PMS FHIR API including the retrieval of the fhirUser and patient resources. The Health Check App will also query any FHIR resource required in the health check’s Questionnaire pre-population expressions, using the patient context as search parameter values.

Fill and Submit Health Check

The PMS User fills out the health check form and when finished, submits the form.

Writeback Questionnaire Response

The Health Check App writes back the health check QuestionnaireResponse to the PMS FHIR Server using a FHIR Create request when the health check is new or a FHIR Update when a health check was previously saved as a draft and retrieved for further contribution.

Writeback Extract Transaction

The Health Check App will generate an extract transaction when a health check Questionnaire contains items with specified extract expressions. The extract transaction is a FHIR Bundle that the health check App will write back to the PMS FHIR API transaction endpoint.

The resource types included in the extract transaction will be specified in the health check Questionnaire, hence the PMS is required to ensure it has writeback capability for any health check Questionnaire it launches.

The extract transaction can include writeback requests using the following FHIR interactions:

  1. Create; or
  2. Patch