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-ballot 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
Official URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager | Version: 4.0.0-ballot | |||
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 the S&I Framework's [[index.html | 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. |
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement sdc-form-manager
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.
server
The primary focus of the repository is the definition of [[Questionnaire]]s. However, [[ValueSet]]s and [[CodeSystem]]s 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]].)
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 | code, context, date, identifier, publisher, status, title, version, definition | Questionnaire.group.question.options | ||
CodeSystem | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem | y | y | y | y | y | y | y | code, date, description, name, status, system, url, assembledFrom, assemble-expectation | |||
ValueSet | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | y | y | y | y | y | y | y | date, description, name, reference, status | ValueSet.compose.import |
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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | code | token | |
SHALL | context | token | |
SHALL | date | date | |
SHALL | identifier | token | |
SHALL | publisher | string | |
SHALL | status | token | |
SHALL | title | string | |
SHALL | version | token | |
SHALL | definition | token |
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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | code | token | |
SHALL | date | date | |
SHALL | description | string | |
SHALL | name | string | |
SHALL | status | token | |
SHALL | system | uri | |
SHALL | url | uri | |
SHOULD | assembledFrom | token | |
SHOULD | assemble-expectation | token |
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.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | |
SHALL | description | string | |
SHALL | name | string | |
SHALL | reference | uri | |
SHALL | status | token |