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

SDC Form Designer

  • Implementation Guide Version: 4.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • 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, 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 this implementation guide.html.

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-questionnaireYy?YYYy?y?url, version, status, experimental, context-type-quantity, context-type-value, date, definition, description, identifier, publisher, questionnaire-code, code, combo-code, subject-type, title, effective, jurisdiction, assemble-expectation, assembled-from
ValueSethttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valuesetYy?YYYYy?url, version, experimental, status, reference, date, context-type-quantity, context-type-value, identifier, title, description, jurisdiction, publisher
CodeSystemhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystemy?y?YYYYy?url, version, experimental, status, content-mode, date, context-type-quantity, context-type-value, identifier, supplements, title, description, jurisdiction, publisher, language
Libraryhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-libraryy?y?YYYYy?url, version, experimental, status, description, content-type, type, date, publisher, context-type-quantity, context-type-value, effective, title, jurisdiction
StructureMaphttp://hl7.org/fhir/StructureDefinition/StructureMapy?y?YYYYy?url, version, experimental, status, source, target, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitiony?y?YYYYy?url, version, experimental, status, type, derivation, kind, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction
ConceptMaphttp://hl7.org/fhir/StructureDefinition/ConceptMapy?y?YYYYy?url, version, experimental, status, source-system, target-system, date, publisher, context-type-quantity, context-type-value, title, source-uri, target-uri, description, jurisdiction

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.

  • MAY support
    history-instance

    Allows review of changes to a 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.

Documentation

Form Designers are responsible for handling form discovery and management.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLstatustoken
SHALLexperimentaltoken
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDdatedate
SHOULDdefinitionuri
SHOULDdescriptionstring
SHOULDidentifiertoken
SHOULDpublisherstring
SHOULDquestionnaire-codetoken
SHOULDcodetoken
SHOULDcombo-codetoken
SHOULDsubject-typetoken
SHOULDtitlestring
MAYeffectivedate
MAYjurisdictiontoken
MAYassemble-expectationtoken
MAYassembled-fromreference
 

Resource Conformance: SHOULD 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 details if search does not or after a create or update if the server makes changes

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

  • MAY support
    history-instance

    Allows review of changes to a value set over time

    vread

    Allows retrieval of a historical version of a value set

Documentation

Form Designers will usually need to find and manage value sets, whether on a Form Manager or an external terminology service.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLreferenceuri
SHOULDdatedate
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDidentifiertoken
SHOULDtitlestring
MAYdescriptionstring
MAYjurisdictiontoken
MAYpublisherstring
 

Resource Conformance: SHOULD CodeSystem

Base System Profile
SDC Code System
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

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

    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.

  • SHOULD support
    delete

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

  • MAY support
    read

    Allows retrieval of details if search does not or after a create or update if the server makes changes

    history-instance

    Allows review of changes to a code system over time

    vread

    Allows retrieval of a historical version of a code system

Documentation

Form Designers will usually need to find and manage code systems, whether on a Form Manager or an external terminology service.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLcontent-modetoken
SHOULDdatedate
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDidentifiertoken
SHOULDsupplementsreference
SHOULDtitlestring
MAYdescriptionstring
MAYjurisdictiontoken
MAYpublisherstring
MAYlanguagetoken
 

Resource Conformance: SHOULD Library

Base System Profile
SDC Library
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing libraries for use by questions in a form

    create

    Allows definition of a new library used by one or more questions

    update

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

  • SHOULD support
    delete

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

  • MAY support
    read

    Allows retrieval of details if search does not or after a create or update if the server makes changes

    history-instance

    Allows review of changes to a library over time

    vread

    Allows retrieval of a historical version of a library

Documentation

Allows managing libraries relevant to population, extraction, or other logic

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLdescriptionstring
SHALLcontent-typetoken
SHALLtypetoken
SHOULDdatedate
SHOULDpublisherstring
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDeffectivedate
SHOULDtitlestring
MAYjurisdictiontoken
 

Resource Conformance: MAY StructureMap

Base System Profile
StructureMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing maps for use in converting to or from the form

    create

    Allows definition of a new map for a form

    update

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

  • SHOULD support
    delete

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

  • MAY support
    read

    Allows retrieval of details if search does not or after a create or update if the server makes changes

    history-instance

    Allows review of changes to a map over time

    vread

    Allows retrieval of a historical version of a map

Documentation

Allows managing maps relevant to population or extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLsourcereference
SHALLtargetreference
SHOULDdatedate
SHOULDpublisherstring
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDtitlestring
MAYdescriptionstring
MAYjurisdictiontoken
 

Resource Conformance: MAY StructureDefinition

Base System Profile
StructureDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing structures

    create

    Allows definition of new structures for use with forms

    update

    Allows existing structures to be maintained. Note that certain types of updates may necessitate retiring the existing structure and defining a new one.

  • SHOULD support
    delete

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

  • MAY support
    read

    Allows retrieval of details if search does not or after a create or update if the server makes changes

    history-instance

    Allows review of changes to a structure over time

    vread

    Allows retrieval of a historical version of a structures

Documentation

Allows managing structures relevant to map-based population and/or map-based or definition-based extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLtypeuri
SHALLderivationtoken
SHALLkindtoken
SHOULDdatedate
SHOULDpublisherstring
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDtitlestring
MAYdescriptionstring
MAYjurisdictiontoken
 

Resource Conformance: MAY ConceptMap

Base System Profile
ConceptMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing maps for use in converting codes used the form

    create

    Allows definition of a new map for codes in a form

    update

    Allows existing maps used by forms to be maintained. Note that certain types of updates may necessitate retiring the existing map and defining a new one.

  • SHOULD support
    delete

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

  • MAY support
    read

    Allows retrieval of details if search does not or after a create or update if the server makes changes

    history-instance

    Allows review of changes to a map over time

    vread

    Allows retrieval of a historical version of a map

Documentation

Allows managing code maps relevant to population or extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLexperimentaltoken
SHALLstatustoken
SHALLsource-systemuri
SHALLtarget-systemuri
SHALLsource-urireference
SHALLtarget-urireference
SHOULDdatedate
SHOULDpublisherstring
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDtitlestring
MAYdescriptionstring
MAYjurisdictiontoken