Smart Health Checks
0.4.0 - ci-build

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.4.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.4.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.4.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

- http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch|2.2.0

## 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 `transaction`interaction.
- Supports the `batch`interaction.

### 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 Type | Profile | R | S | U | P | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
AllergyIntolerance | Supported Profiles Smart Health Checks AllergyIntolerance |  | y |  | y | y | patient |  |  |
Bundle | Supported Profiles Smart Health Checks Extract Bundle |  |  |  |  |  |  |  |  |
Condition | Supported Profiles Smart Health Checks Condition |  | y |  | y | y | patient, category |  |  |
Encounter | Supported Profiles Smart Health Checks Encounter | y |  |  |  |  |  |  |  |
Immunization | Supported Profiles Smart Health Checks Immunization |  | y |  |  | y | patient, status |  |  |
Medication | Supported Profiles Smart Health Checks Medication | y |  |  |  |  |  |  |  |
MedicationStatement | Supported Profiles Smart Health Checks MedicationStatement |  | y |  | y | y | patient, status, _include | `MedicationStatement:medication` |  |
Observation | 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 |  | y |  |  | y | patient, code, _sort |  |  |
Parameters | Supported Profiles Smart Health Checks Patch AllergyIntolerance Smart Health Checks Patch Condition Smart Health Checks Patch MedicationStatement |  |  |  |  |  |  |  |  |
Patient | Supported Profiles Smart Health Checks Patient | y |  |  |  |  |  |  |  |
Practitioner | Supported Profiles Smart Health Checks Practitioner | y |  |  |  |  |  |  |  |
Questionnaire | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire |  | y |  |  | y | url, version, title, _count, _sort |  |  | `$assemble`, `$populate`
QuestionnaireResponse | https://smartforms.csiro.au/ig/StructureDefinition/SHCQuestionnaireResponse | y | y | y |  | y | patient, questionnaire, status, _count, _sort |  |  |
ValueSet |  |  |  |  |  |  |  |  |  | `$expand`

#### Resource Conformance: supportedAllergyIntolerance

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient | `reference`

#### Resource Conformance: supportedBundle

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: supportedCondition

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | category | `token` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+category | `reference`+`token`

#### Resource Conformance: supportedEncounter

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: supportedImmunization

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | status | `token` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+status | `reference`+`token`

#### Resource Conformance: supportedMedication

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: supportedMedicationStatement

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | status | `token` | 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 | _include | `reference` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+status | `reference`+`token`
| patient+status+_include | `reference`+`token`+`reference`

#### Resource Conformance: SHALLObservation

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | code | `token` | The client SHALL provide at least a code value and MAY provide both the code and system values. The server SHALL support both.
SHALL | _sort | `string` | The client and server SHALL support search result sorting by date and MAY support other values.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
| patient+code+_sort | `reference`+`token`+`string`

#### Resource Conformance: supportedParameters

Core FHIR Resource
Parameters
Reference Policy
Interaction summary

Supported Profiles

Smart Health Checks Patch AllergyIntolerance
Smart Health Checks Patch Condition
Smart Health Checks Patch MedicationStatement

Documentation

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

#### Resource Conformance: supportedPatient

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: supportedPractitioner

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: supportedQuestionnaire

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | url | `uri` |
SHALL | version | `token` |
SHALL | title | `string` | The client supports search using the :contains modifier.
SHALL | _count | `number` | The client supports search result limiting.
SHALL | _sort | `string` | The client supports search result sorting by date and MAY support other values.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
| url+version | `uri`+`token`
| _count+_sort | `number`+`string`
| title+_count+_sort | `string`+`number`+`string`

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $assemble |
SHALL | $populate |

#### Resource Conformance: supportedQuestionnaireResponse

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | questionnaire | `reference` | 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.
SHALL | status | `token` | The client SHALL provide at least a code value and MAY provide both the code and system values. The server SHALL support both.
SHALL | _count | `number` | The client and server SHALL support search result limiting.
SHALL | _sort | `string` | The client and server SHALL support search result sorting by authored and MAY support other values.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
| patient+_count+_sort | `reference`+`number`+`string`
| patient+_count+_sort+questionnaire | `reference`+`number`+`string`+`reference`
| patient+_count+_sort+status | `reference`+`number`+`string`+`token`

#### Resource Conformance: supportedValueSet

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

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $expand |