Structured Data Capture
3.0.0 - STU 3
Structured Data Capture
3.0.0 - STU 3
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.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/OperationDefinition/Questionnaire-populate | Version: 3.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: SDCPopulateQuestionnaire | ||
Generates a QuestionnaireResponse instance based on a specified Questionnaire, filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire. If the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef in parameters must be provided. If called at the instance level, these parameters will be ignored. The response will contain a QuestionnaireResponse instance based on the specified Questionnaire and/or an OperationOutcome resource with errors or warnings. The QuestionnaireResponse instance will be populated with an unanswered set of questions following the group and question structure of the specified Questionnaire. If content parameters were specified or the local parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions. Population of the QuestionnaireResponse with appropriate data is dependent on the questions and/or groups in the Questionnaire having metadata that allows the server to recognize the questions. Guidance on mechanisms to perform population can be found here. Regardless of the mechanism used to link the questions in a questionnaire to a “known” mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.
URL: [base]/Questionnaire/$populate
URL: [base]/Questionnaire/[id]/$populate
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | identifier | 0..1 | Identifier | A logical questionnaire identifier (i.e. | ||
| IN | canonical | 0..1 | uri | The canonical identifier for the questionnaire (optionally version-specific). | ||
| IN | questionnaire | 0..1 | Questionnaire | The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion | ||
| IN | questionnaireRef | 0..1 | Reference | The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire. | ||
| IN | subject | 1..1 | Reference | The resource that is to be the QuestionnaireResponse.subject. The QuestionnaireResponse instance will reference the provided subject. In addition, if the local parameter is set to true, server information about the specified subject will be used to populate the instance. | ||
| IN | context | 0..* | Resources containing information to be used to help populate the QuestionnaireResponse. These will typically be FHIR resources, though alternative population mechanisms might allow consumption of binaries containing FHIR documents, CDA documents or other source materials. Servers might not support all possible source materials and may ignore materials they do not recognize. (They MAY provide warnings if ignoring submitted resources.) | |||
| IN | context.name | 0..* | string | The name of the launchContext or root Questionnaire variable the passed content should be used as for population purposes. The name SHALL correspond to a launchContext or variable delared at the root of the Questionnaire. | ||
| IN | context.content | 0..* | Reference | The actual resource (or resources) to use as the value of the launchContext or variable. | ||
| IN | local | 0..1 | boolean | If specified and set to | ||
| IN | launchContext | 0..1 | Extension | Resources that provide context for form processing logic (pre-population) when creating/displaying/editing a QuestionnaireResponse. | ||
| OUT | response | 1..1 | QuestionnaireResponse | The partially (or fully)-populated set of answers for the specified Questionnaire | ||
| OUT | issues | 0..1 | OperationOutcome | A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter |
While it is theoretically possible for a QuestionnaireResponse instance to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. A client SHOULD ensure that a human submitter has an opportunity to review the auto-populated answers to confirm correctness as well as to complete or expand on information provided by the auto-population process. When creating an "empty" questionnaire, the general algorithm is to create a QuestionnaireResponse with one item for every item in the source Questionnaire, including items with "enableWhen", "display" items, etc. If a question has a default, the default answer should be populated. And the QuestionnaireResponse should point back to the originating Questionnaire. Repeating items will typically only include a single repetition. Other extensions and/or elements may also be populated if the system is aware of appropriate values. Complex form designs with conditional logic or tight constraints on cardinalities may be challenging to auto-populate. A server MAY choose to traverse the questionnaire as if it were a human respondent, answering only those questions that are enabled based on previously answered questions. However, doing so may result in minimal population. Alternatively, systems may choose to populate all known answers, independent of dependencies and other constraints. This may cause questions to be answered that should not be answered. It will be up to the client to appropriately prune the final populated questionnaire once human review has taken place. Invoking this operation with the content parameter may involve the disclosure of personally identifiable healthcare information to the system which is performing the population process. No such disclosures should be made unless the system on which the operation is being invoked is a "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#3.0.0 based on FHIR 4.0.1. Generated 2023-12-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change