This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions
StructureDefinition-argo-adap-questionnaireresponse
The Argonaut Adaptive QuestionnaireResponse Profile supports the adaptive questionnaire use case and is derived from the Argonaut QuestionnaireResponse profile. This profile defines the structure that is passed between the Client and Server using the $next-question
operation and records the question-answer pairs and questionnaire questions from the adaptive questionnaire.
Mandatory Data Element:
Additional Profile specific implementation guidance:
See the Argonaut QuestionnaireResponse Profile for a description of the constraints on the data elements.
If a question is marked as repeats
= true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. The responses should not be posted to the Service until after all the responses are entered.
Examples
- Adaptive Sampler Response Completed adaptive questionnaire based on the Sampler example
- Adpative PHQ-9 Response Completed adaptive questionnaire based on the PHQ-9 example
- Adaptive AUDIT-C Response Completed adaptive questionnaire based on the AUDIT-C example
- Adaptive DAST Response Completed adaptive questionnaire based on the DAST example
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is:
http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse
Published on Sat Feb 16 00:00:00 AEDT 2019 as active by the Argonaut Project.
This profile builds on argo_questionnaireresponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | I | 0..* | A structured set of questions and their answers | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | SI | 1..1 | argo_questionnaire | A structured set of questions |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-responsePeriod | S | 0..1 | Period | Extension URL: http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
basedOn | Σ | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) | Request fulfilled by this QuestionnaireResponse |
parent | Σ | 0..* | Reference(Observation | Procedure) | Part of this action |
questionnaire | SΣ | 1..1 | Reference(Argonaut Questionnaire Profile) | Form being answered |
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The subject of the questions |
context | SΣ | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed |
authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
author | SΣ | 0..1 | Reference(US Core Practitioner | US Core Patient Profile | Device | RelatedPerson) | Person who received and recorded the answers |
source | SΣ | 0..1 | Reference(US Core Practitioner | US Core Patient Profile | RelatedPerson) | The person who answered the questions |
item | SI | 0..* | BackboneElement | Groups and questions |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-responsePeriod | S | 0..1 | Period | Extension URL: http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
definition | 0..1 | uri | ElementDefinition - details for the item | |
text | S | 0..1 | string | Name for group or question text |
subject | 0..1 | Reference(Resource) | The subject this group's answers are about | |
answer | SI | 0..* | BackboneElement | The response(s) to the question |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | S | 0..1 | boolean, date, dateTime, decimal, integer, time, string, uri, Coding, Quantity | Single-valued answer to the question Binding: Questionnaire Answer Codes (example) |
item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested groups and questions | |
item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested questionnaire response items | |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | I | 0..* | A structured set of questions and their answers | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | SI | 1..1 | argo_questionnaire | A structured set of questions |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-responsePeriod | S | 0..1 | Period | Extension URL: http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | Unique id for this set of answers |
basedOn | Σ | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) | Request fulfilled by this QuestionnaireResponse |
parent | Σ | 0..* | Reference(Observation | Procedure) | Part of this action |
questionnaire | SΣ | 1..1 | Reference(Argonaut Questionnaire Profile) | Form being answered |
status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required) |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | The subject of the questions |
context | SΣ | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed |
authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
author | SΣ | 0..1 | Reference(US Core Practitioner | US Core Patient Profile | Device | RelatedPerson) | Person who received and recorded the answers |
source | SΣ | 0..1 | Reference(US Core Practitioner | US Core Patient Profile | RelatedPerson) | The person who answered the questions |
item | SI | 0..* | BackboneElement | Groups and questions |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-responsePeriod | S | 0..1 | Period | Extension URL: http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
definition | 0..1 | uri | ElementDefinition - details for the item | |
text | S | 0..1 | string | Name for group or question text |
subject | 0..1 | Reference(Resource) | The subject this group's answers are about | |
answer | SI | 0..* | BackboneElement | The response(s) to the question |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | S | 0..1 | boolean, date, dateTime, decimal, integer, time, string, uri, Coding, Quantity | Single-valued answer to the question Binding: Questionnaire Answer Codes (example) |
item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested groups and questions | |
item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested questionnaire response items | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
Adaptive Forms Use Case: