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 Manager

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

This profile defines the expected capabilities of the SDC Form Manager role when conforming to this implementation guide. This role builds on the SDC Form Fill Manager by adding the ability to create and maintain Questionnaires and their associated resources.

Raw OpenAPI-Swagger Definition file | Download

SDC Form Manager

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

This CapabilityStatement imports the CapabilityStatement SDC Form Fill Manager

FHIR RESTful Capabilities

Mode: server

The primary focus is being able to create and update Questionnaires. However, creation and maintenance of ValueSets, CodeSystems, Librarys, and other associated resources is also potentially relevant, though in some cases these might be maintained on separate servers.

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 TypeProfileRSUCDSearches_include_revincludeOperations
Questionnairehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireYYYYdefinition, code, combo-code, assembled-from$assemble
ValueSethttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valuesetYYYYstatus, reference, experimental, date, context-type-quantity, context-type-value, identifier, title, description, jurisdiction, publisher
CodeSystemhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystemYYYYstatus, content-mode, experimental, date, publisher, context-type-quantity, context-type-value, identifier, supplements, title, description, jurisdiction, language
Libraryhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-libraryYYYYexperimental, status, description, content-type, type, date, publisher, context-type-quantity, context-type-value, effective, title, jurisdiction
StructureMaphttp://hl7.org/fhir/StructureDefinition/StructureMapYYYYexperimental, status, source, target, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitionYYYYexperimental, status, type, derivation, kind, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction
ConceptMaphttp://hl7.org/fhir/StructureDefinition/ConceptMapYYYYexperimental, 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
    read

    Allows retrieval of a resource before or after performing a create or update.

    create

    Allows defining a new form. Repositories requiring curation of submitted forms may require all new data elements to have a status of 'draft'.

    update

    Allows an existing form to be updated. Servers may choose to prohibit certain types of edits, instead requiring the creation of a new questionnaire (and potentially the retiring of the existing questionnaire). Servers may also limit who can change particular forms.

  • SHOULD support
    delete

    Allows removal of an existing form. Servers may choose to not support deletions and instead require that the form's status be changed to 'retired'. Other systems support deletions but limit them to forms meeting certain requirements. E.g. only forms with a status of draft or only forms that have been retired for at least two years, etc.

Documentation

Form mamagers are responsible for creating and updating forms.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDdefinitionuri
SHOULDcodetoken
SHOULDcombo-codetoken
MAYassembled-fromreference
 
Extended Operations
ConformanceOperationDocumentation
MAY$assemble

Needed as part of the authoring process if modular questionnaires are used and assembly isn't done locally

Resource Conformance: SHALL ValueSet

Base System Profile
SDC Value Set
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    read

    Allows retrieval of a resource before or after performing a create or update.

    create

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

    update

    Allows existing value sets referenced by one or more questionnaires to be maintained

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

Documentation

Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstatustoken
SHALLreferenceuri
SHALLexperimentaltoken
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
    read

    Allows retrieval of a resource before or after performing a create or update.

    create

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

    update

    Allows existing code systems referenced by one or more questionnaires to be maintained

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

Documentation

Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service.

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

Resource Conformance: SHOULD Library

Base System Profile
SDC Library
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    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 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.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
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
    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 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.

Documentation

Allows managing maps relevant to population or extraction

Search Parameters
ConformanceParameterTypeDocumentation
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
    read

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

    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.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
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
    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 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.

Documentation

Allows managing code maps relevant to population or extraction

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