Structured Data Capture
4.0.0-ballot - STU 4 ballot 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 4.0.0-ballot 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 Designer

Official URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-designer Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: SDCFormDesigner
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.13.2

This profile defines the expected capabilities of the ''SDC Form Designer'' role when conforming to the S&I Framework's [[index.html Structured Data Capture FHIR implementation guide]]. This role is responsible for defining forms ([[Questionnaire]] resource instances) that include references to [[StructureDefinition]] resouces containing data elements that define the meaning of particular questions and can be used to aid in pre-populating and auto-populating forms.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement sdc-form-designer

SDC Form Designer

  • Implementation Guide Version: 4.0.0-ballot
  • FHIR Version: 1.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2014-07-06
  • 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: client

The [[Questionnaire]] resource is used to create and maintain SDC-compliant forms. The [[StructureDefinition]] resource is used to look-up existing data elements that can be referenced in forms. Optionally, [[StructureDefinition]]s can also be created and maintained in conjunction with form editing. This is an optional feature as not all environments will provide support for data element definitions from form authors. The [[ValueSet]] and [[CodeSystem]] resources are used to capture allowed values for questions that are to be answered from a pre-defined list of values. For some forms, some or all of the referenced value sets (and possibly code systems) will be handled as 'contained' resources, meaning the value set exists only in the context of the [[Questionnaire]] and cannot be referenced or maintained without also updating the form. However, systems should support value set and code system re-use across questionnaires. (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-questionnaireyyyyyyy
ValueSethttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valuesetyyyyyyy

Resource Conformance: SHALL Questionnaire

Base System Profile
SDC Base Questionnaire
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing questionnaires for editing

    read

    Allows retrieval of a specific questionnaire by id

    create

    Allows submission of a new form design

    update

    Allows revision of an existing form design. Note that certain types of updates may necessitate retiring the existing form and defining a new one.

  • SHOULD support
    history-instance

    Allows review of changes to questionnaire over time

    vread

    Allows retrieval of a historical version of a questionnaire

  • MAY support
    delete

    Not all servers will support deletion of forms. Status change to 'retired' will be more typical, though deletion of draft profiles may keep repositories cleaner.

Resource Conformance: SHALL ValueSet

Base System Profile
SDC Value Set
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing value sets for use by questions in a form

    read

    Allows retrieval of a specific value set by id

    create

    Allows definition of a new value set used by one or more questions

    update

    Allows existing value sets referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing value set and defining a new one.

  • SHOULD support
    history-instance

    Allows review of changes to a value set over time

    vread

    Allows retrieval of a historical version of a value set

  • MAY support
    delete

    Not all servers will support deletion of value sets. Status change to 'retired' will be more typical, though deletion of draft value sets may keep repositories cleaner.