Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture
4.0.0-ballot - STU 4 ballot
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-filler | Version: 4.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCFormFiller | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.13.3 | ||||
| This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html | Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms. Note that Form Fillers may also take on the role of [[CapabilityStatement-sdc-form-archiver.html |
Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it). |
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement sdc-form-filler
xml, jsonNote 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.
clientThe [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.<br/>Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''
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 | |||||||
| ValueSet | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | y | y | y | ||||||||
| CodeSystem | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem | y | y | y | ||||||||
| QuestionnaireResponse | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse | y | y | y | y | y | y | |||||
| DocumentReference | y | |||||||||||
| Binary | y | y |
search-typeAllows discovery of existing questionnaires to be completed
readAllows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.
history-instanceAllows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.
vreadAllows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.
readAllows retrieval of a specific value set by id (as referenced in a Questionnaire)
vreadAllows retrieval of a specific version of a value set (as referenced in a Questionnaire)
history-instanceAllows review of changes to a value set over time. Of interest to some systems, but probably not most.
readAllows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)
vreadAllows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)
history-instanceAllows review of changes to a code system over time. Of interest to some systems, but probably not most.
search-typeAllows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.
readAllows retrieval of a specific QuestionnaireResponse by id.
createAllows recording a completed or partially-completed form
updateAllows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)
deleteAllows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances.
history-instanceAllows review of prior versions of an answer set - allows reversion to previously recorded versions
search-typeAllows discovery of existing documents that may be included in a form pre-population request
readAllows retrieval of a specific binary (as pointed to by a DocumentReference)
vreadAllows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change