Smart Forms
0.2.0-draft - trial-use

This page is part of the Smart Forms (v0.2.0-draft: R1 Draft) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: Smart Forms Server

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

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 Server. The Smart Forms Server provides a definitional repository of resources that a client application can retrieve for use in a Smart Forms context. The capabilities listed include supported FHIR profiles, RESTful operations, and search parameters.

Raw OpenAPI-Swagger Definition file | Download

Smart Forms Server Capability Statement

  • Kind of capability statement: capability
  • FHIR Version: 4.0.1
  • Supported Formats: json and xml
  • 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.

Implements a Subset of the Following Capability Statements:

FHIR RESTful Capabilities

Mode: server

The Smart Forms Server provides interactions for hosting Questionnaire resources and the assembly of modular Questionnaires.

Security

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
Questionnairehttp://hl7.org/fhir/StructureDefinition/Questionnaire
Additional supported profiles:
yyurl, version, title, _count, _sort, url+version, _count+_sort, title+_count+_sort $assemble

Questionnaire

Interaction summary
  • Supports read, search-type.

Search Parameters
Parameter Type Documentation
urluri

versiontoken

titlestring

The server supports search using the :contains modifier.

_countnumber

The server supports search result limiting.

_sortstring

The server 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