Structured Data Capture
4.0.0 - 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 Fill Manager

Official URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-fill-manager Version: 4.0.0
Standards status: Trial-use Active as of 2014-07-06 Maturity Level: 4 Computable Name: SDCFormFillManager
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.13.7

This profile defines the expected capabilities of the SDC Form Fill Manager role when conforming to this implementation guide. This role is responsible for maintaining a repository of form definitions for retrieval by form fillers possibly also supporting pre-population of form data.

Raw OpenAPI-Swagger Definition file | Download

SDC Form Fill 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.

FHIR RESTful Capabilities

Mode: server

The primary focus of the repository is providing access to Questionnaires. However, ValueSets, CodeSystems, Librarys, ConceptMaps and other resources are also relevant in their support of Questionnaire functionality. Some forms will opt to have some or all of these additional resources managed as 'contained' resources, meaning there won't be a need for them to be independently managed on the Form Fill Manager. However, systems should support resource re-use across forms, meaning that support for maintenance of these ancillary resources is still helpful. (Version-specific referencing can be used to avoid referenced resources 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 TypeProfileRSUCSearches_include_revincludeOperations
Questionnairehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireYYurl, version, status, experimental, context-type-quantity, context-type-value, date, description, identifier, publisher, questionnaire-code, subject-type, title, effective, jurisdiction, assemble-expectation$next-question, $populate
ValueSethttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valuesety?Yurl, version$expand, $validate code
CodeSystemhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystemYYurl, version
Libraryhttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-libraryy?Yurl, version
StructureMaphttp://hl7.org/fhir/StructureDefinition/StructureMapy?Yurl, version
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitiony?Yurl, version
ConceptMaphttp://hl7.org/fhir/StructureDefinition/ConceptMapy?Yexperimental, url, version, status, source-system, target-system, source-uri, target-uri

Resource Conformance: SHALL Questionnaire

Base System Profile
SDC Base Questionnaire
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows a user to search for existing forms

    read

    Allows retrieval of a detailed Questionnaire if search only returns summary

Documentation

Form mamagers are responsible for handling forms.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLstatustoken
SHALLexperimentaltoken
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
SHOULDdatedate
SHOULDdescriptionstring
SHOULDidentifiertoken
SHOULDpublisherstring
SHOULDquestionnaire-codetoken
SHOULDsubject-typetoken
SHOULDtitlestring
SHOULDeffectivedate
MAYjurisdictiontoken
MAYassemble-expectationtoken
 
Extended Operations
ConformanceOperationDocumentation
SHOULD$next-question

Needed for adaptive forms

MAY$populate

Usefulness depends on whether fillers tend to perform population themselves

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 in authoring questionnaires

  • MAY support
    read

    Needed if a server's default search behavior doesn't return the full resource

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
 
Extended Operations
ConformanceOperationDocumentation
SHOULD$expand

Needed if expansion isn't handled locally or via independent terminology servers

SHOULD$validate code

Needed if expansion isn't handled locally or via independent terminology servers

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 in authoring questionnaires

    read

    Allows retrieval of a specific code system referenced within a questionnaire

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
 

Resource Conformance: SHOULD Library

Base System Profile
SDC Library
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Needed to retrieve library based on canonical reference

  • MAY support
    read

    Useful if a server doesn't return full data in a search

Documentation

Needed for certain types of population and extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
 

Resource Conformance: MAY StructureMap

Base System Profile
StructureMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Needed to retrieve structure map based on canonical reference

  • MAY support
    read

    Useful if a server doesn't return full data in a search

Documentation

Needed if performing map-based population or extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
 

Resource Conformance: MAY StructureDefinition

Base System Profile
StructureDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Needed to retrieve structure definition based on canonical reference

  • MAY support
    read

    Useful if a server doesn't return full data in a search

Documentation

Needed if performing map-based population or map or definition-based extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
 

Resource Conformance: MAY ConceptMap

Base System Profile
ConceptMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Needed to retrieve concept map based on various criteria

  • MAY support
    read

    Useful if a server doesn't return full data in a search

Documentation

May be needed for code conversion during population or extraction

Search Parameters
ConformanceParameterTypeDocumentation
SHALLexperimentaltoken
SHALLurluri
SHALLversiontoken
SHALLstatustoken
SHALLsource-systemuri
SHALLtarget-systemuri
SHOULDsource-urireference
SHOULDtarget-urireference