This page is part of the Structured Data Capture FHIR IG (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
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
xml
, json
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.
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]].)
Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | C | D | H-I | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Questionnaire | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire | y | y | y | y | y | y | y | ||||
ValueSet | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | y | y | y | y | y | y | y |
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.
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.