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

CapabilityStatement: SHC Host FHIR Server

Official URL: https://smartforms.csiro.au/ig/CapabilityStatement/SHCHostFHIRServerCapabilityStatement Version: 0.3.0
Draft as of 2025-04-16 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/.

This CapabilityStatement describes the expected capabilities for systems to launch and exchange data with the SHC App to support the Aboriginal and Torres Strait Islander Health Check. It lists the server's conformance expectations for the resource types required as a launch context, resource types required to support prepopulation of the form, resource types required to support writing back to the patient record, and QuestionnaireResponse requirements for managing form responses. These expectations include supported FHIR profiles, RESTful operations, and search parameters.

Raw OpenAPI-Swagger Definition file | Download

SHC Host FHIR Server

  • Implementation Guide Version: 0.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json
  • Supported Patch Formats: SHALL support application/fhir+json
  • Published on: 2025-04-16
  • Published by: AEHRC CSIRO

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

SHOULD Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Smart Forms Launcher Server SHALL:

  1. Support the Smart Health Checks AllergyIntolerance resource profile
  2. ​Support the Smart Health Checks AllergyIntolerance Patch resource profile
  3. Support the Smart Health Checks Condition resource profile
  4. ​Support the Smart Health Checks Condition Patch resource profile
  5. Support the Smart Health Checks Encounter resource profile
  6. Support the Smart Health Checks Immunization resource profile
  7. Support the Smart Health Checks Medication profile
  8. Support the Smart Health Checks MedicationStatement profile
  9. ​Support the Smart Health Checks MedicationStatement Patch profile
  10. Support the Smart Health Checks Observation resource profiles
  11. Support the Smart Health Checks Patient resource profile
  12. Support the Smart Health Checks Practitioner resource profile
  13. Support the Smart Health Checks QuestionnaireResponse resource profile
  14. Support the Smart Health Checks Extract Bundle resource profile
  15. Implement the RESTful behavior according to the FHIR specification
  16. Support JSON source formats for all interactions
Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

Smart Forms Launcher Server SHALL:

  1. Support CORS headers
  2. Support SMART on FHIR security services

Also see the AU Core Security and Privacy section for general considerations and recommendations.

Summary of System-wide Interactions
  • SHALL support the transactioninteraction described as follows:

    The server SHALL support the transaction interaction for all resources.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUPCSearches_include_revincludeOperations
AllergyIntoleranceSupported Profiles
  Smart Health Checks AllergyIntolerance		YYYpatient
BundleSupported Profiles
  Smart Health Checks Extract Bundle
ConditionSupported Profiles
  Smart Health Checks Condition		YYYpatient, category, patient+category
EncounterSupported Profiles
  Smart Health Checks Encounter		Y
ImmunizationSupported Profiles
  Smart Health Checks Immunization		YYpatient, status, patient+status
MedicationSupported Profiles
  Smart Health Checks Medication		Y
MedicationStatementSupported Profiles
  Smart Health Checks MedicationStatement		YYYpatient, status, _include, patient+status, patient+status+_includeMedicationStatement:medication
ObservationSupported Profiles
  Smart Health Checks Blood Pressure
  Smart Health Checks Body Height
  Smart Health Checks Body Weight
  Smart Health Checks Pathology Result
  Smart Health Checks Head Circumference
  Smart Health Checks Heart Rate
  Smart Health Checks Heart Rhythm
  Smart Health Checks Waist Circumference
  Smart Health Checks Smoking Status		YYpatient, code, _sort, patient+code+_sort
ParametersSupported Profiles
  https://smartforms.csiro.au/ig/StructureDefinition/SHCAllergyIntolerancePatch
  https://smartforms.csiro.au/ig/StructureDefinition/SHCConditionPatch
  https://smartforms.csiro.au/ig/StructureDefinition/SHCMedicationStatementPatch
PatientSupported Profiles
  Smart Health Checks Patient		YY
PractitionerSupported Profiles
  Smart Health Checks Practitioner		Y
QuestionnaireResponseSupported Profiles
  Smart Health Checks Questionnaire Response		YYYYpatient, questionnaire, status, _count, _sort, patient+_count+_sort, patient+_count+_sort+questionnaire, patient+_count+_sort+status

Resource Conformance: SHALL AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • SHALL support search-type, create, patch.

Supported Profiles

Smart Health Checks AllergyIntolerance

Documentation

The server SHALL support the AllergyIntolerance resource, the Smart Health Checks profile and the conformance expectations for the AllergyIntolerance resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

 

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary

    Supported Profiles

    Smart Health Checks Extract Bundle

    Documentation

    The server SHALL support the Bundle resource, the Smart Health Checks profile listed and the conformance expectations for the Bundle resource.

    Resource Conformance: SHALL Condition

    Core FHIR Resource
    Condition
    Reference Policy
    Interaction summary
    • SHALL support search-type, create, patch.

    Supported Profiles

    Smart Health Checks Condition

    Documentation

    The server SHALL support the Condition resource, the Smart Health Checks profile and the conformance expectations for the Condition resource.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLpatientreference

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

    SHALLcategorytoken

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

    Combined Search Parameters
    ConformanceParametersTypes
    SHALLpatient+categoryreference+token

    Resource Conformance: SHALL Encounter

    Core FHIR Resource
    Encounter
    Reference Policy
    Interaction summary
    • SHALL support read.

    Supported Profiles

    Smart Health Checks Encounter

    Documentation

    The server SHALL support the Encounter resource, Smart Health Checks profile and the conformance expectations for the Encounter resource.

    Resource Conformance: SHALL Immunization

    Core FHIR Resource
    Immunization
    Reference Policy
    Interaction summary
    • SHALL support search-type, create.

    Supported Profiles

    Smart Health Checks Immunization

    Documentation

    The server SHALL support the Immunization resource, the Smart Health Checks profile and the conformance expectations for the Immunization resource.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLpatientreference

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

    SHALLstatustoken

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

    Combined Search Parameters
    ConformanceParametersTypes
    SHALLpatient+statusreference+token

    Resource Conformance: MAY Medication

    Core FHIR Resource
    Medication
    Reference Policy
    Interaction summary
    • SHALL support read.

    Supported Profiles

    Smart Health Checks Medication

    Documentation

    If an external reference to a Medication resource is used in MedicationStatement, then the server SHALL support the Medication resource, the Smart Health Checks profile and the conformance expectations for the Medication resource.

    Resource Conformance: SHALL MedicationStatement

    Core FHIR Resource
    MedicationStatement
    Reference Policy
    Interaction summary
    • SHALL support search-type, create, patch.

    Supported Profiles

    Smart Health Checks MedicationStatement

    Documentation

    The server SHALL support the MedicationStatement resource, the Smart Health Checks profile and the conformance expectations for the MedicationStatement resource.

    If a medication in a MedicationStatement resource is represented as an external Medication resource reference, the server SHALL support the _include parameter for searching this element (MedicationStatement:medication)

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLpatientreference

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

    SHALLstatustoken

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

    The client SHALL support multipleOr.

    The server SHALL support multipleOr.

    MAY_includereference

    If a medication in a MedicationStatement resource is represented as an external Medication resource reference, the server SHALL support the _include parameter for searching this element (MedicationStatement:medication).

    The client SHALL support this method.

    Combined Search Parameters
    ConformanceParametersTypes
    SHALLpatient+statusreference+token
    MAYpatient+status+_includereference+token+reference

    Resource Conformance: SHALL Observation

    Core FHIR Resource
    Observation
    Reference Policy
    Interaction summary
    • SHALL support search-type, create.

    Supported Profiles

    Smart Health Checks Blood Pressure
    Smart Health Checks Body Height
    Smart Health Checks Body Weight
    Smart Health Checks Pathology Result
    Smart Health Checks Head Circumference
    Smart Health Checks Heart Rate
    Smart Health Checks Heart Rhythm
    Smart Health Checks Waist Circumference
    Smart Health Checks Smoking Status

    Documentation

    The server SHALL support the Observation resource, the Smart Health Checks profiles listed and the conformance expectations for the Observation resource.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLpatientreference

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

    SHALLcodetoken

    The client SHALL provide at least a code value and MAY provide both the code and system values.

    The server SHALL support both.

    SHALL_sortstring

    The client and server SHALL support search result sorting by date and MAY support other values.

    Combined Search Parameters
    ConformanceParametersTypes
    SHALLpatient+code+_sortreference+token+string

    Resource Conformance: SHALL Parameters

    Core FHIR Resource
    Parameters
    Reference Policy
    Interaction summary

      Supported Profiles

      https://smartforms.csiro.au/ig/StructureDefinition/SHCAllergyIntolerancePatch
      https://smartforms.csiro.au/ig/StructureDefinition/SHCConditionPatch
      https://smartforms.csiro.au/ig/StructureDefinition/SHCMedicationStatementPatch

      Documentation

      The server SHALL support the Parameters resource, the Smart Health Checks profiles listed and the conformance expectations for the Parameters resource.

      Resource Conformance: SHALL Patient

      Core FHIR Resource
      Patient
      Reference Policy
      Interaction summary
      • SHALL support read, patch.

      Supported Profiles

      Smart Health Checks Patient

      Documentation

      The server SHALL support the Patient resource, Smart Health Checks profile and the conformance expectations for the Patient resource.

      Resource Conformance: SHALL Practitioner

      Core FHIR Resource
      Practitioner
      Reference Policy
      Interaction summary
      • SHALL support read.

      Supported Profiles

      Smart Health Checks Practitioner

      Documentation

      The server SHALL support the Practitioner resource, Smart Health Checks profile and the conformance expectations for the Practitioner resource.

      Resource Conformance: SHALL QuestionnaireResponse

      Core FHIR Resource
      QuestionnaireResponse
      Reference Policy
      Interaction summary
      • SHALL support read, search-type, create, update.

      Supported Profiles

      Smart Health Checks Questionnaire Response

      Documentation

      The server SHALL support the QuestionnaireResponse resource, Smart Health Checks profile and the conformance expectations for the QuestionnaireResponse resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLpatientreference

      The client SHALL provide at least a id value and MAY provide both the Type and id values.

      The server SHALL support both.

      SHALLquestionnairereference

      The client SHALL provide at least a id value and MAY provide both the Type and id values.

      The server SHALL support both.

      The client and server SHALL support chained search questionnaire.title using the :contains modifier.

      SHALLstatustoken

      The client SHALL provide at least a code value and MAY provide both the code and system values.

      The server SHALL support both.

      SHALL_countnumber

      The client and server SHALL support search result limiting.

      SHALL_sortstring

      The client and server SHALL support search result sorting by authored and MAY support other values.

      Combined Search Parameters
      ConformanceParametersTypes
      SHALLpatient+_count+_sortreference+number+string
      SHALLpatient+_count+_sort+questionnairereference+number+string+reference
      SHALLpatient+_count+_sort+statusreference+number+string+token