Smart Forms
0.2.0 - ci-build

Smart Forms, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.2.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: Smart Forms Application

Official URL: https://smartforms.csiro.au/ig/CapabilityStatement/SmartFormsApplication Version: 0.2.0
Draft as of 2023-06-16 Computable Name: SmartFormsApplication

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 Smart Forms Application. These capabilities include supported FHIR profiles, RESTful operations, and search parameters. It covers supported tasks such as SMART App launch context, prepopulation and completion of forms.

Raw OpenAPI-Swagger Definition file | Download

Smart Forms Application Capability Statement

  • Kind of capability statement: capability
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Published by: AEHRC CSIRO

Note to Implementers: FHIR Capabilities

Additional FHIR capabilities may be 'allowed' by the system. Only the capabilities relevant to Smart Forms have been included in this capability statement.

Supports the Following Implementation Guides

Implements a Subset of the Following Capability Statements:

FHIR RESTful Capabilities

Mode: client

The Smart Forms Application performs interactions to support SMART App Launch, form prepopulation and form filling.

Security

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 C Searches _include _revinclude Operations
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles: 		y
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioner
Additional supported profiles: 		y
Encounterhttp://hl7.org/fhir/StructureDefinition/Encounter
Additional supported profiles: 		y
Conditionhttp://hl7.org/fhir/StructureDefinition/Condition
Additional supported profiles: 		ypatient, clinical-status, patient+clinical-status
ObservationSupported profiles: ycode, patient, _count, _sort, code+patient+_count+_sort
Questionnairehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire yyurl, version, title, _count, _sort, url+version, _count+_sort, title+_count+_sort$assemble, $populate
QuestionnaireResponsehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse yyyypatient, questionnaire, questionnaire.title, status, _count, _sort, patient+_count+_sort, patient+questionnaire+_count+_sort, patient+questionnaire.title+_count+_sort, patient+status+_count+_sort
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSet $expand

Patient

Base System Profile
http://hl7.org/fhir/StructureDefinition/Patient
Supported Profiles
Interaction summary
  • Supports read.

Practitioner

Base System Profile
http://hl7.org/fhir/StructureDefinition/Practitioner
Supported Profiles
Interaction summary
  • Supports read.

Encounter

Base System Profile
http://hl7.org/fhir/StructureDefinition/Encounter
Supported Profiles
Interaction summary
  • Supports read.

Condition

Base System Profile
http://hl7.org/fhir/StructureDefinition/Condition
Supported Profiles
Interaction summary
  • Supports search-type.
Search Parameters
Parameter Type Documentation
patientreference

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

clinical-statustoken

The client SHALL provide at least a code value and MAY provide both the code and system values. The server SHALL support both.
Combined Search Parameters
Parameters Types
patient+ clinical-status reference+token

Observation

Supported Profiles
Interaction summary
  • Supports search-type.
Search Parameters
Parameter Type Documentation
patientreference

The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.

codetoken

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

_countnumber

The client supports search result limiting.

_sortstring

The client supports search result sorting by date and MAY support other values.
Combined Search Parameters
Parameters Types
patient+ code+ _count+ _sort reference+token+number+string

Questionnaire

Base System Profile
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire
Interaction summary
  • Supports search-type, create.
Search Parameters
Parameter Type Documentation
urluri

versiontoken

titlestring

The client supports search using the :contains modifier.

_countnumber

The client supports search result limiting.

_sortstring

The client supports search result sorting by date and MAY support other values.
Combined Search Parameters
Parameters Types
url+ version uri+token
_count+ _sort number+string
title+ _count+ _sort string+number+string
Operations
Operation Documentation
$assemble

$populate

QuestionnaireResponse

Base System Profile
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse
Interaction summary
  • Supports read, search-type, update, create.
  • All search requests SHALL at least include the patient parameter.
Search Parameters
Parameter Type Documentation
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.

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.

questionnaire.title string

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

statustoken

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

_countnumber

The client supports search result limiting.

_sortstring

The client supports search result sorting by authored and MAY support other values.
Combined Search Parameters
Parameters Types
patient+ _count+ _sort reference+number+string
patient+ questionnaire+ _count+ _sort reference+reference+number+string
patient+ questionnaire.title+ _count+ _sort reference+string+number+string
patient+ status+ _count+ _sort reference+token+number+string

ValueSet

Base System Profile
http://hl7.org/fhir/StructureDefinition/ValueSet
Operations
Operation Documentation
$expand