Generated Narrative: CapabilityStatement sdc-form-filler SDC Form Filler Implementation Guide Version: 4.0.0 FHIR Version: 4.0.1 Supported Formats: xml, json Published on: 2014-07-06 Published by: HL7 International / FHIR Infrastructure 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. FHIR RESTful Capabilities Mode: client The Questionnaire, ValueSet and CodeSystem resources are retrieved to allow the system to guide the user through the entry process. The QuestionnaireResponse resource is used to record the populated form. Finally, the Library, StructureMap, StructureDefinition, and ConceptMap resources are available to assist with population. 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 Security Implementations must meet the general security requirements documented in this implementation guide.html. Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R V-R S U C D H-I Searches _include _revinclude Operations QuestionnaireResponse http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse Y Y Y Y Y Y $extract Questionnaire http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire y? y? Y y? url, version, status, experimental, context-type-quantity, context-type-value, date, description, identifier, publisher, questionnaire-code, subject-type, title, effective, jurisdiction, assemble-expectation $next-question, $populate ValueSet http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset y? Y url, version $expand, $validate code CodeSystem http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem y? Y url, version Library http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library y? Y url, version StructureMap http://hl7.org/fhir/StructureDefinition/StructureMap y? Y url, version StructureDefinition http://hl7.org/fhir/StructureDefinition/StructureDefinition y? Y url, version ConceptMap http://hl7.org/fhir/StructureDefinition/ConceptMap y? Y experimental, url, version, status, source-system, target-system, source-uri, target-uri Resource Conformance: SHALL QuestionnaireResponse Base System Profile SDC Standard Questionnaire Response Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update. read Allows retrieval of a specific QuestionnaireResponse by id. create Allows recording a completed or partially-completed form update Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.) delete Allows 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. SHOULD support history-instance Allows review of prior versions of an answer set - allows reversion to previously recorded versions Documentation The primary focus of a form filler is creating and managing QuestionnaireResponses. Extended Operations Conformance Operation Documentation MAY $extract This is only necessary if the form filler doesn't handle all needed extraction capabilities locally and extraction is actually peformed by the form filler rather than a downstream process Resource Conformance: SHOULD Questionnaire Base System Profile SDC Base Questionnaire Profile Conformance SHALL Reference Policy Interaction summary SHOULD support search-type Allows discovery of existing questionnaires to be completed. Without this, forms need to be explicitly passed in as part of workflow. MAY support read Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id. history-instance Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most. vread Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only. Documentation If not supported, then forms will need to be made accessible through workflow Search Parameters 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 description string SHOULD identifier token SHOULD publisher string SHOULD questionnaire-code token SHOULD subject-type token SHOULD title string SHOULD effective date MAY jurisdiction token MAY assemble-expectation token Extended Operations Conformance Operation Documentation SHOULD $next-question This is only necessary if the form filler doesn't handle all needed population capabilities locally SHOULD $populate This is only necessary if the form filler doesn't handle all needed population capabilities locally Resource Conformance: SHALL ValueSet Base System Profile SDC Value Set Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve value set based on canonical reference MAY support read Useful if a server doesn't return full data in a search Documentation Needed to support simple value sets that might not be known to the terminology server or for local expansion and validation Search Parameters Conformance Parameter Type Documentation SHALL url uri SHALL version token Extended Operations Conformance Operation Documentation SHOULD $expand Needed to determine allowed code choices. SHALL be supported unless handled locally SHOULD $validate code Needed when populating from existing data (to confim the code is part of the value set). SHOULD be supported unless handled locally Resource Conformance: MAY CodeSystem Base System Profile SDC Code System Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve code system based on canonical reference MAY support read Useful if a server doesn't return full data in a search Documentation SHALL be supported if doing any terminology expansions or validation locally Search Parameters Conformance Parameter Type Documentation SHALL url uri SHALL version token Resource Conformance: SHOULD Library Base System Profile SDC Library Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve library based on canonical reference MAY support read Useful if a server doesn't return full data in a search Documentation Needed for certain types of population and extraction Search Parameters Conformance Parameter Type Documentation SHALL url uri SHALL version token Resource Conformance: SHOULD StructureMap Base System Profile StructureMap Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve structure map based on canonical reference MAY support read Useful if a server doesn't return full data in a search Documentation Needed if performing map-based population or extraction Search Parameters Conformance Parameter Type Documentation SHALL url uri SHALL version token Resource Conformance: SHOULD StructureDefinition Base System Profile StructureDefinition Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve structure definition based on canonical reference MAY support read Useful if a server doesn't return full data in a search Documentation Needed if performing map-based population or map or definition-based extraction Search Parameters Conformance Parameter Type Documentation SHALL url uri SHALL version token Resource Conformance: SHOULD ConceptMap Base System Profile ConceptMap Profile Conformance SHALL Reference Policy Interaction summary SHALL support search-type Needed to retrieve concept map based on various criteria MAY support read Useful if a server doesn't return full data in a search Documentation May be needed for code conversion during population or extraction Search Parameters Conformance Parameter Type Documentation SHALL experimental token SHALL url uri SHALL version token SHALL status token SHALL source-system uri SHALL target-system uri SHOULD source-uri reference SHOULD target-uri reference
This profile defines the expected capabilities of the *SDC Form Filler*' role when conforming to this 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 [Form Archiver](CapabilityStatement-sdc-form-archiver.html) if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it). In addition to the features described here, Form Fillers **SHOULD** also support search_type on all resources that might need to be looked up either for attachments or as References. The expectations for supported resources, profiles, and relevant search parameters will typically come from national 'base' or 'core' IGs.
The [Questionnaire], [ValueSet] and [CodeSystem] resources are retrieved to allow the system to guide the user through the entry process. The [QuestionnaireResponse] resource is used to record the populated form. Finally, the Library, StructureMap, StructureDefinition, and ConceptMap resources are available to assist with population. 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](CapabilityStatement-sdc-form-response-manager.html)
Implementations must meet the [general security requirements](security.html) documented in this implementation guide.html.
The primary focus of a form filler is creating and managing QuestionnaireResponses.
Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.
Allows retrieval of a specific QuestionnaireResponse by id.
Allows recording a completed or partially-completed form
Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)
Allows 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.
Allows review of prior versions of an answer set - allows reversion to previously recorded versions
This is only necessary if the form filler doesn't handle all needed extraction capabilities locally and extraction is actually peformed by the form filler rather than a downstream process
If not supported, then forms will need to be made accessible through workflow
Allows discovery of existing questionnaires to be completed. Without this, forms need to be explicitly passed in as part of workflow.
Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.
Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.
Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.
This is only necessary if the form filler doesn't handle all needed population capabilities locally
Needed to support simple value sets that might not be known to the terminology server or for local expansion and validation
Useful if a server doesn't return full data in a search
Needed to retrieve value set based on canonical reference
Needed to determine allowed code choices. **SHALL** be supported unless handled locally
Needed when populating from existing data (to confim the code is part of the value set). **SHOULD** be supported unless handled locally
**SHALL** be supported if doing any terminology expansions or validation locally
Needed to retrieve code system based on canonical reference
Needed for certain types of population and extraction
Needed to retrieve library based on canonical reference
Needed if performing map-based population or extraction
Needed to retrieve structure map based on canonical reference
Needed if performing map-based population or map or definition-based extraction
Needed to retrieve structure definition based on canonical reference
May be needed for code conversion during population or extraction
Needed to retrieve concept map based on various criteria