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 App

Official URL: https://smartforms.csiro.au/ig/CapabilityStatement/SHCAppCapabilityStatement Version: 0.3.0
Draft as of 2025-04-16 Computable Name: SHCApp

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 capabilities of the SHC App. These capabilities include supported FHIR profiles, RESTful operations, and search parameters. It covers supported tasks such as SMART App launch context, prepopulation, write-back of extracted resources and completion of forms.

Raw OpenAPI-Swagger Definition file | Download

SHC App

  • Implementation Guide Version: 0.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats: 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.

This CapabilityStatement instantiates these CapabilityStatements SDC Form Filler, AU Core Requester CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: client

The SHC App performs interactions to support SMART App Launch, form prepopulation, write-back of extracted resources and form filling.

Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

SMART App Launch supported to allow secure data exchange.

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the batchinteraction.

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
EncounterSupported Profiles
  Smart Health Checks Encounter		y
ImmunizationSupported Profiles
  Smart Health Checks Immunization		yypatient, status
MedicationSupported Profiles
  Smart Health Checks Medication		y
MedicationStatementSupported Profiles
  Smart Health Checks MedicationStatement		yyypatient, status, _includeMedicationStatement:medication
ObservationSupported Profiles
  Smart Health Checks Blood Pressure
  Smart Health Checks Body Height
  Smart Health Checks Body Weight
  Smart Health Checks Head Circumference
  Smart Health Checks Heart Rate
  Smart Health Checks Heart Rhythm
  Smart Health Checks Pathology Result
  Smart Health Checks Smoking Status
  Smart Health Checks Waist Circumference		yypatient, code, _sort
ParametersSupported Profiles
  Smart Health Checks Patch
PatientSupported Profiles
  Smart Health Checks Patient		y
PractitionerSupported Profiles
  Smart Health Checks Practitioner		y
Questionnairehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireyyurl, version, title, _count, _sort$assemble, $populate
QuestionnaireResponsehttps://smartforms.csiro.au/ig/StructureDefinition/SHCQuestionnaireResponseyyyypatient, questionnaire, status, _count, _sort
ValueSet $expand

Resource Conformance: supported AllergyIntolerance

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

Supported Profiles

Smart Health Checks AllergyIntolerance

Documentation

The client supports 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.

Combined Search Parameters
ConformanceParametersTypes
 patientreference

Resource Conformance: supported Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary

    Supported Profiles

    Smart Health Checks Extract Bundle

    Documentation

    The client supports the Bundle resource, the Smart Health Checks profile listed and the conformance expectations for the Bundle resource.

    Resource Conformance: supported Condition

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

    Supported Profiles

    Smart Health Checks Condition

    Documentation

    The client supports the Condition resource, the Smart Health Checks 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
     patient+categoryreference+token

    Resource Conformance: supported Encounter

    Core FHIR Resource
    Encounter
    Reference Policy
    Interaction summary
    • Supports read.

    Supported Profiles

    Smart Health Checks Encounter

    Documentation

    The client supports the Encounter resource, the Smart Health Checks profile and the conformance expectations for the Encounter resource.

    Resource Conformance: supported Immunization

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

    Supported Profiles

    Smart Health Checks Immunization

    Documentation

    The client supports 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
     patient+statusreference+token

    Resource Conformance: supported Medication

    Core FHIR Resource
    Medication
    Reference Policy
    Interaction summary
    • Supports read.

    Supported Profiles

    Smart Health Checks Medication

    Documentation

    The client supports the Medication resource, the Smart Health Checks profile and the conformance expectations for the Medication resource.

    Resource Conformance: supported MedicationStatement

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

    Supported Profiles

    Smart Health Checks MedicationStatement

    Documentation

    The client supports the MedicationStatement resource, the Smart Health Checks profile and the conformance expectations for the MedicationStatement 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.

    The client SHALL support multipleOr.

    The server SHALL support multipleOr.

    SHALL_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
     patient+statusreference+token
     patient+status+_includereference+token+reference

    Resource Conformance: SHALL Observation

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

    Supported Profiles

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

    Documentation

    The client supports 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
     patient+code+_sortreference+token+string

    Resource Conformance: supported Parameters

    Core FHIR Resource
    Parameters
    Reference Policy
    Interaction summary

      Supported Profiles

      Smart Health Checks Patch

      Documentation

      The client supports the Parameters resource, the Smart Health Checks profiles listed and the conformance expectations for the Parameters resource.

      Resource Conformance: supported Patient

      Core FHIR Resource
      Patient
      Reference Policy
      Interaction summary
      • Supports read.

      Supported Profiles

      Smart Health Checks Patient

      Documentation

      The client supports the Patient resource, Smart Health Checks profile and the conformance expectations for the Patient resource.

      Resource Conformance: supported Practitioner

      Core FHIR Resource
      Practitioner
      Reference Policy
      Interaction summary
      • Supports read.

      Supported Profiles

      Smart Health Checks Practitioner

      Documentation

      The client supports the Practitioner resource, Smart Health Checks profile and the conformance expectations for the Practitioner resource.

      Resource Conformance: supported Questionnaire

      Base System Profile
      SDC Base Questionnaire
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary
      • Supports search-type, create.

      Documentation

      The client supports the Questionnaire resource, Structured Data Capture profile and the conformance expectations for the Questionnaire resource.

      Search Parameters
      ConformanceParameterTypeDocumentation
      SHALLurluri
      SHALLversiontoken
      SHALLtitlestring

      The client supports search using the :contains modifier.

      SHALL_countnumber

      The client supports search result limiting.

      SHALL_sortstring

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

      Combined Search Parameters
      ConformanceParametersTypes
       url+versionuri+token
       _count+_sortnumber+string
       title+_count+_sortstring+number+string
      Extended Operations
      ConformanceOperationDocumentation
      SHALL$assemble
      SHALL$populate

      Resource Conformance: supported QuestionnaireResponse

      Base System Profile
      Smart Health Checks Questionnaire Response
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary
      • Supports read, search-type, create, update.

      Documentation

      The client supports 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
       patient+_count+_sortreference+number+string
       patient+_count+_sort+questionnairereference+number+string+reference
       patient+_count+_sort+statusreference+number+string+token

      Resource Conformance: supported ValueSet

      Core FHIR Resource
      ValueSet
      Reference Policy
      Interaction summary

        Documentation

        The client supports the ValueSet resource and the conformance expectations for the ValueSet resource.

        Extended Operations
        ConformanceOperationDocumentation
        SHALL$expand