Structured Data Capture
2.8.0 - CI Build

Structured Data Capture, published by HL7 International - FHIR Infrastructure Work Group. This is not an authorized publication; it is the continuous build for version 2.8.0). 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

Raw OpenAPI-Swagger Definition file | Download

SDCFormDesigner

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-designer Published: 2014-07-06 (draft)

Published by: HL7 International - FHIR Infrastructure

This profile defines the expected capabilities of the SDC Form Designer role when conforming to the S&I Framework's 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.

General

FHIR Version: $ver$
Supported formats: xml, json

REST behavior

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, StructureDefinitions 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 SDC implementation guide.

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
Questionnaire (Profile) Yes Yes Yes Yes Yes Yes Yes
ValueSet (Profile) Yes Yes Yes Yes Yes Yes Yes
CodeSystem (Profile) Yes Yes Yes Yes Yes Yes Yes


Questionnaire

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire

Interactions

Name Description
  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.

  history-instance

Allows review of changes to questionnaire over time

  vread

Allows retrieval of a historical version of a questionnaire

  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.



ValueSet

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset

Interactions

Name Description
  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.

  history-instance

Allows review of changes to a value set over time

  vread

Allows retrieval of a historical version of a value set

  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.



CodeSystem

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem

Interactions

Name Description
  search-type

Allows discovery of existing code systems for use by questions in a form

  read

Allows retrieval of a specific code system by id

  create

Allows definition of a new code system used by one or more questions

  update

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

  history-instance

Allows review of changes to a code system over time

  vread

Allows retrieval of a historical version of a code system

  delete

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