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-designer | Version: 4.0.0 | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCFormDesigner | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.13.2 |
This profile defines the expected capabilities of the SDC Form Designer role when conforming to this implementation guide. This role is responsible for defining forms (Questionnaire resource instances) that include references to StructureDefinition resouces containing data elements that define the meaning of particular questions and can be used to aid in pre-populating and auto-populating forms.
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.
client
The Questionnaire resource is used to create and maintain SDC-compliant forms. The StructureDefinition resource is used to look-up existing data elements that can be referenced in forms. Optionally, StructureDefinitions can also be created and maintained in conjunction with form editing. This is an optional feature as not all environments will provide support for data element definitions from form authors. The ValueSet and CodeSystem resources are used to capture allowed values for questions that are to be answered from a pre-defined list of values. For some forms, some or all of the referenced value sets (and possibly code systems) will be handled as 'contained' resources, meaning the value set exists only in the context of the Questionnaire and cannot be referenced or maintained without also updating the form. However, systems should support value set and code system re-use across questionnaires. (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 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 | 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? | url, version, status, experimental, context-type-quantity, context-type-value, date, definition, description, identifier, publisher, questionnaire-code, code, combo-code, subject-type, title, effective, jurisdiction, assemble-expectation, assembled-from | |||
ValueSet | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | Y | y? | Y | Y | Y | Y | y? | url, version, experimental, status, reference, 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 | Y | Y | y? | url, version, experimental, status, content-mode, date, context-type-quantity, context-type-value, identifier, supplements, title, description, jurisdiction, publisher, language | |||
Library | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library | y? | y? | Y | Y | Y | Y | y? | url, version, 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 | Y | Y | y? | url, version, 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 | Y | Y | y? | url, version, 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 | Y | Y | y? | url, version, experimental, status, source-system, target-system, date, publisher, context-type-quantity, context-type-value, title, source-uri, target-uri, description, jurisdiction |
search-type
Allows discovery of existing questionnaires for editing
read
Allows retrieval of a specific questionnaire by id
create
Allows submission of a new form design
update
Allows revision of an existing form design. Note that certain types of updates may necessitate retiring the existing form and defining a new one.
history-instance
Allows review of changes to a questionnaire over time
vread
Allows retrieval of a historical version of a questionnaire
delete
Not all servers will support deletion of forms. Status change to 'retired' will be more typical, though deletion of draft profiles may keep repositories cleaner.
Form Designers are responsible for handling form discovery and management.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
SHALL | status | token | |
SHALL | experimental | token | |
SHOULD | context-type-quantity | composite | |
SHOULD | context-type-value | composite | |
SHOULD | date | date | |
SHOULD | definition | uri | |
SHOULD | description | string | |
SHOULD | identifier | token | |
SHOULD | publisher | string | |
SHOULD | questionnaire-code | token | |
SHOULD | code | token | |
SHOULD | combo-code | token | |
SHOULD | subject-type | token | |
SHOULD | title | string | |
MAY | effective | date | |
MAY | jurisdiction | token | |
MAY | assemble-expectation | token | |
MAY | assembled-from | reference |
search-type
Allows discovery of existing value sets for use by questions in a form
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 value set used by one or more questions
update
Allows existing value sets referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing value set and defining a new one.
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.
history-instance
Allows review of changes to a value set over time
vread
Allows retrieval of a historical version of a value set
Form Designers will usually need to find and manage value sets, whether on a Form Manager or an external terminology service.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | reference | uri | |
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 |
search-type
Allows discovery of existing code systems for use by questions in a form
create
Allows definition of a new code system used by one or more questions
update
Allows existing code systems referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing code system and defining a new one.
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.
read
Allows retrieval of details if search does not or after a create or update if the server makes changes
history-instance
Allows review of changes to a code system over time
vread
Allows retrieval of a historical version of a code system
Form Designers will usually need to find and manage code systems, whether on a Form Manager or an external terminology service.
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
SHALL | experimental | token | |
SHALL | status | token | |
SHALL | content-mode | token | |
SHOULD | date | date | |
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 | publisher | string | |
MAY | language | token |
search-type
Allows discovery of existing libraries for use by questions in a form
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.
read
Allows retrieval of details if search does not or after a create or update if the server makes changes
history-instance
Allows review of changes to a library over time
vread
Allows retrieval of a historical version of a library
Allows managing libraries relevant to population, extraction, or other logic
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
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 |
search-type
Allows discovery of existing maps for use in converting to or from the form
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.
read
Allows retrieval of details if search does not or after a create or update if the server makes changes
history-instance
Allows review of changes to a map over time
vread
Allows retrieval of a historical version of a map
Allows managing maps relevant to population or extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
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 |
search-type
Allows discovery of existing structures
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.
read
Allows retrieval of details if search does not or after a create or update if the server makes changes
history-instance
Allows review of changes to a structure over time
vread
Allows retrieval of a historical version of a structures
Allows managing structures relevant to map-based population and/or map-based or definition-based extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
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 |
search-type
Allows discovery of existing maps for use in converting codes used the form
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.
read
Allows retrieval of details if search does not or after a create or update if the server makes changes
history-instance
Allows review of changes to a map over time
vread
Allows retrieval of a historical version of a map
Allows managing code maps relevant to population or extraction
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | url | uri | |
SHALL | version | token | |
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 |