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
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
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.
This CapabilityStatement imports the CapabilityStatement SDC Form Fill Manager
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.
Implementations must meet the general security requirements documented in this implementation guide.html.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
Questionnaire | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire | Y | Y | Y | Y | definition, code, combo-code, assembled-from | $assemble | |||
ValueSet | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | Y | Y | Y | Y | status, reference, experimental, date, context-type-quantity, context-type-value, identifier, title, description, jurisdiction, publisher | ||||
CodeSystem | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem | Y | Y | Y | Y | status, content-mode, experimental, date, publisher, context-type-quantity, context-type-value, identifier, supplements, title, description, jurisdiction, language | ||||
Library | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library | Y | Y | Y | Y | experimental, status, description, content-type, type, date, publisher, context-type-quantity, context-type-value, effective, title, jurisdiction | ||||
StructureMap | http://hl7.org/fhir/StructureDefinition/StructureMap | Y | Y | Y | Y | experimental, status, source, target, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction | ||||
StructureDefinition | http://hl7.org/fhir/StructureDefinition/StructureDefinition | Y | Y | Y | Y | experimental, status, type, derivation, kind, date, publisher, context-type-quantity, context-type-value, title, description, jurisdiction | ||||
ConceptMap | http://hl7.org/fhir/StructureDefinition/ConceptMap | Y | Y | Y | Y | experimental, status, source-system, target-system, date, publisher, context-type-quantity, context-type-value, title, source-uri, target-uri, description, jurisdiction |
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.
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.
Form mamagers are responsible for creating and updating forms.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHOULD | definition | uri | |
SHOULD | code | token | |
SHOULD | combo-code | token | |
MAY | assembled-from | reference |
Conformance | Operation | Documentation |
---|---|---|
MAY | $assemble | Needed as part of the authoring process if modular questionnaires are used and assembly isn't done locally |
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
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.
Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | status | token | |
SHALL | reference | uri | |
SHALL | experimental | token | |
SHOULD | date | date | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | identifier | token | |
SHOULD | title | string | |
MAY | description | string | |
MAY | jurisdiction | token | |
MAY | publisher | string |
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
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.
Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | status | token | |
SHALL | content-mode | token | |
SHALL | experimental | token | |
SHOULD | date | date | |
SHOULD | publisher | string | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | identifier | token | |
SHOULD | supplements | reference | |
SHOULD | title | string | |
MAY | description | string | |
MAY | jurisdiction | token | |
MAY | language | token |
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.
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.
Allows managing libraries relevant to population, extraction, or other logic
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | description | string | |
SHALL | content-type | token | |
SHALL | type | token | |
SHOULD | date | date | |
SHOULD | publisher | string | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | effective | date | |
SHOULD | title | string | |
MAY | jurisdiction | token |
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.
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.
Allows managing maps relevant to population or extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | source | reference | |
SHALL | target | reference | |
SHOULD | date | date | |
SHOULD | publisher | string | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | title | string | |
MAY | description | string | |
MAY | jurisdiction | token |
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.
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.
Allows managing structures relevant to map-based population and/or map-based or definition-based extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | type | uri | |
SHALL | derivation | token | |
SHALL | kind | token | |
SHOULD | date | date | |
SHOULD | publisher | string | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | title | string | |
MAY | description | string | |
MAY | jurisdiction | token |
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.
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.
Allows managing code maps relevant to population or extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | source-system | uri | |
SHALL | target-system | uri | |
SHALL | source-uri | reference | |
SHALL | target-uri | reference | |
SHOULD | date | date | |
SHOULD | publisher | string | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | title | string | |
MAY | description | string | |
MAY | jurisdiction | token |