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 Host FHIR Server

Official URL: https://smartforms.csiro.au/ig/CapabilityStatement/SHCHostFHIRServerCapabilityStatement | Version: 0.4.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.4.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

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

### SHOULD Support the Following Implementation Guides

- http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc

## 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 Condition resource profile
3. Support the Smart Health Checks Encounter resource profile
4. Support the Smart Health Checks Immunization resource profile
5. Support the Smart Health Checks Medication profile
6. Support the Smart Health Checks MedicationStatement profile
7. Support the Smart Health Checks Observation resource profiles
8. Support the Smart Health Checks Patient resource profile
9. Support the Smart Health Checks Practitioner resource profile
10. Support the Smart Health Checks QuestionnaireResponse resource profile
11. Support the Smart Health Checks Patch AllergyIntolerance profile
12. Support the Smart Health Checks Patch Condition profile
13. Support the Smart Health Checks Patch MedicationStatement 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 `transaction`interaction 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 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, patient+category |  |  |
Encounter | Supported Profiles Smart Health Checks Encounter | Y |  |  |  |  |  |  |  |
Immunization | Supported Profiles Smart Health Checks Immunization |  | Y |  |  | Y | patient, status, patient+status |  |  |
Medication | Supported Profiles Smart Health Checks Medication | Y |  |  |  |  |  |  |  |
MedicationStatement | Supported Profiles Smart Health Checks MedicationStatement |  | Y |  | Y | Y | patient, status, _include, patient+status, 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, 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 |  |  |  |  |  |  |  |
QuestionnaireResponse | Supported Profiles Smart Health Checks Questionnaire Response | Y | Y | Y |  | Y | patient, questionnaire, status, _count, _sort, patient+_count+_sort, patient+_count+_sort+questionnaire, patient+_count+_sort+status |  |  |

#### Resource Conformance: SHALLAllergyIntolerance

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

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.

#### Resource Conformance: SHALLBundle

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

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
MAY | 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.
MAY | 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
--- | --- | ---
SHALL | patient+category | `reference`+`token`

#### Resource Conformance: SHALLEncounter

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

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
MAY | 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.
MAY | 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
--- | --- | ---
SHALL | patient+status | `reference`+`token`

#### Resource Conformance: MAYMedication

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

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
MAY | 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.
MAY | 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`.
MAY | _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
--- | --- | ---
SHALL | patient+status | `reference`+`token`
MAY | patient+status+_include | `reference`+`token`+`reference`

#### Resource Conformance: SHALLObservation

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 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 server SHALL support the Observation resource, the Smart Health Checks profiles listed and the conformance expectations for the Observation resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
MAY | 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.
MAY | 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.
MAY | _sort | `string` | The client and server SHALL support search result sorting by date and MAY support other values.

Combined Search Parameters

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

#### Resource Conformance: SHALLParameters

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 server SHALL support the Parameters resource, the Smart Health Checks profile and the conformance expectations for the Parameters resource.

#### Resource Conformance: SHALLPatient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

- SHALL support `read`.

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

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

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
MAY | 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.
MAY | 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.
MAY | 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.
MAY | _count | `number` | The client and server SHALL support search result limiting.
MAY | _sort | `string` | The client and server SHALL support search result sorting by authored and MAY support other values.

Combined Search Parameters

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