Structured Data Capture
3.0.0 - STU 3 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

CapabilityStatement: SDC Form Manager

Official URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager Version: 3.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SDCFormManager

This profile defines the expected capabilities of the ‘‘SDC Form Manager’’ role when conforming to the S&I Framework’s [[index.html Structured Data Capture FHIR implementation guide]]. This role is responsible for maintaining a repository of form definitions and also of performing pre-population of form data.

Raw OpenAPI-Swagger Definition file | Download

SDC Form Manager

  • Implementation Guide Version: 3.0.0
  • FHIR Version: 1.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Sun Jul 06 00:00:00 UTC 2014
  • Published by: HL7 International / FHIR Infrastructure

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.

FHIR RESTful Capabilities

Mode: server

The primary focus of the repository is the definition of [[Questionnaire]]s. However, [[ValueSet]]s and [[CodeSystem]]s must also be supported to allow definition of coded data elements. Some data elements will choose to maintain value sets as 'contained' resources, meaning the value set exists only in the context of the data element and cannot be referenced or maintained without also updating the data element. However, systems should support value set re-use across data elements. (Version-specific referencing can be used to avoid value sets from changing independent of the referencing [[Questionnaire]].)

Security

Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].

Summary of System-wide Interactions

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 TypeProfileRV-RSUCDH-ISearches_include_revincludeOperations
Questionnairehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireyyyyyyycode, context, date, identifier, publisher, status, title, version, definitionQuestionnaire.group.question.options
CodeSystemhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystemyyyyyyycode, date, description, name, status, system, url, assembledFrom, assemble-expectation
ValueSethttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valuesetyyyyyyydate, description, name, reference, statusValueSet.compose.import

Resource Conformance: SHALLQuestionnaire

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, read, vread, history-instance, create, update.
  • MAY support delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken
SHALLcontexttoken
SHALLdatedate
SHALLidentifiertoken
SHALLpublisherstring
SHALLstatustoken
SHALLtitlestring
SHALLversiontoken
SHALLdefinitiontoken
 

Resource Conformance: SHALLCodeSystem

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, read, vread, history-instance, create, update.
  • MAY support delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken
SHALLdatedate
SHALLdescriptionstring
SHALLnamestring
SHALLstatustoken
SHALLsystemuri
SHALLurluri
SHOULDassembledFromtoken
SHOULDassemble-expectationtoken
 

Resource Conformance: SHALLValueSet

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, read, vread, history-instance, create, update.
  • MAY support delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLdescriptionstring
SHALLnamestring
SHALLreferenceuri
SHALLstatustoken