Smart Forms
0.1.0 - ci-build

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

CapabilityStatement: Smart Forms Launcher Server for the Aboriginal and Torres Strait Islander Health Check

Official URL: https://smartforms.csiro.au/ig/CapabilityStatement/SFLauncherServerAboriginalTorresStraitIslanderHealthCheck Version: 0.1.0
Draft as of 2023-06-16 Realm: Australia flag Computable Name: SmartFormsLauncherServerAboriginalTorresStraitIslanderHealthCheck

Copyright/Legal: CSIRO © 2022+; Licensed under Apache License, Version 2.0

This CapabilityStatement describes the expected capabilities for systems to launch and exchange data with the Smart Forms client application 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, and QuestionnaireResponse requirements for managing form responses. These expectations include supported FHIR profiles, RESTful operations, and search parameters.

Raw OpenAPI-Swagger Definition file | Download

Smart Forms Launcher Server for the Aboriginal and Torres Strait Islander Health Check Capability Statement

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

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". Some items might be marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

SHOULD Support the Following Implementation Guides

SHALL Implement the Following Capability Statements:

SHOULD Implement the Following Capability Statements:

FHIR RESTful Capabilities

Mode: server

A Smart Forms Launcher Server SHALL:

  1. Support the AU Core Patient resource profile.
  2. Support the AU Core Practitioner resource profile.
  3. Support the AU Core Encounter resource profile.
  4. Support the AU Core Condition resource profile.
  5. Support the AU Core Observation resource profiles.
  6. Support the SDC Questionnaire Response.
  7. Implement the RESTful behavior according to the FHIR specification.
  8. Support JSON source formats for all interactions.
Security

A Smart Forms Launcher Server SHALL:

  1. Support CORS headers
  2. Support SMART on FHIR security services

See the Structured Data Capture Security Details section for general considerations and recommendations.

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.au/fhir/core/StructureDefinition/au-core-patient y
Practitionerhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner y
Encounterhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter y
Conditionhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-condition ypatient, clinical-status, patient+clinical-status
Observationhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-observation
Additional supported profiles: 		ycode, patient, _count, _sort, code+patient+_count+_sort
QuestionnaireResponsehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse yyyypatient, questionnaire, status, _count, _sort, patient+_count+_sort, patient+questionnaire+_count+_sort, patient+status+_count+_sort

Resource Conformance: SHALLPatient

Base System Profile
http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
Profile Conformance
SHALL
Interaction summary
  • SHALL support read.
Documentation

The server SHALL support the Patient resource, AU Core profile and the conformance expectations for the Patient resource.

Resource Conformance: SHALLPractitioner

Base System Profile
http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner
Profile Conformance
SHALL
Interaction summary
  • SHALL support read.
Documentation

The server SHALL support the Practitioner resource, AU Core profile and the conformance expectations for the Practitioner resource.

Resource Conformance: SHALLEncounter

Base System Profile
http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter
Profile Conformance
SHALL
Interaction summary
  • SHALL support read.
Documentation

The server SHALL support the Encounter resource, AU Core profile and the conformance expectations for the Encounter resource.

Resource Conformance: SHALLCondition

Base System Profile
http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition
Profile Conformance
SHALL
Interaction summary
  • SHALL support search-type.
Documentation

The server SHALL support the Condition resource, the AU Core profile and the conformance expectations for the Condition resource.

Search Parameters
Conformance Parameter Type Documentation
SHALLpatientreference

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

SHALLclinical-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
Conformance Parameters Types
SHALLpatient+ clinical-status reference+token

Resource Conformance: SHALLObservation

Base System Profile
http://hl7.org.au/fhir/core/StructureDefinition/au-core-observation
Profile Conformance
SHALL
Supported Profiles
Supported Profiles Conformance
SHALL
Interaction summary
  • SHALL support search-type.
Documentation

The server SHALL support the Observation resource, the AU Core profiles listed and the conformance expectations for the Observation resource.

Search Parameters
Conformance Parameter Type Documentation
SHALLpatientreference

The client SHALL provide at least an 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_countnumber

The client and server SHALL support search result limiting.

SHALL_sortstring

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

Resource Conformance: SHALLQuestionnaireResponse

Base System Profile
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse
Profile Conformance
SHALL
Interaction summary
  • SHALL support read, search-type, update, create.
Versioning

VersionId tracked fully

The server SHALL correctly track and populate the versionId meta-property on resources and support using e-tags and If-Match header for version integrity in the API.

Documentation

The server SHALL support the QuestionnaireResponse resource, Structured Data Capture profile and the conformance expectations for the QuestionnaireResponse resource.

Search Parameters
Conformance Parameter Type Documentation
SHALLpatient reference

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

SHALLquestionnaire reference

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 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
Conformance Parameters Types
SHALLpatient+ _count+ _sort reference+number+string
SHALLpatient+ questionnaire+ _count+ _sort reference+reference+number+string
SHALLpatient+ status+ _count+ _sort reference+token+number+string