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 Manager

Raw OpenAPI-Swagger Definition file | Download

SDCFormManager

(Requirements Definition Capability Statement)

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

Published by: HL7 International - FHIR Infrastructure

This profile defines the expected capabilities of the SDC Form Manager role when conforming to the S&I Framework's Structured Data Capture FHIR implementation guide. This role is responsible for maintaining a repository of form definitions and also of performing pre-population of form data.

General

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

REST behavior

The primary focus of the repository is the definition of Questionnaires. However, ValueSets and CodeSystems must also be supported to allow definition of coded data elements. Some data elements will choose to maintain value sets as 'contained' resources, meaning the value set exists only in the context of the data element and cannot be referenced or maintained without also updating the data element. However, systems should support value set re-use across data elements. (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
CodeSystem (Profile) Yes Yes Yes Yes Yes Yes Yes
ValueSet (Profile) Yes Yes Yes Yes Yes Yes Yes

Operations:


Questionnaire

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

Interactions

Name Description
  search-type

Allows a user to search for existing forms

  read

Allows retrieval of a specific known form

  vread

Allows retrieval of a specific version of a form

  history-instance

Allows review of changes to a form over time

  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.

  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.

Search

Supported Includes: Questionnaire.group.question.options

Parameter Type Definition & Chaining
code token
context token
date date
identifier token
publisher string
status token
title string
version string
definition token


CodeSystem

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

Interactions

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

  vread

Allows retrieval of a historical version of a code system as referenced within a questionnaire

  history-instance

Allows review of changes to a code system over time

  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

  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.

Search

Parameter Type Definition & Chaining
code token
date date
description string
name string
status token
system uri
url uri


ValueSet

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

Interactions

Name Description
  search-type

Allows discovery of existing value sets for use in authoring questionnaires

  read

Allows retrieval of a specific value set referenced within a questionnaire

  vread

Allows retrieval of a historical version of a value set as referenced within a questionnaire

  history-instance

Allows review of changes to a value set over time

  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

  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.

Search

Supported Includes: ValueSet.compose.import

Parameter Type Definition & Chaining
date date
description string
name string
reference string
status token