This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
StructureDefinition-argo-questionnaireresponse
Scope and Usage
The Argonaut QuestionnaireResponse resource supports:
- The completed Answer to an assessment form
- Links to questions and associated scores for question-answer/answer choice
- Because of it standardized data structure, it is shareable across systems enabling data aggregation and analysis
Mandatory Data Elements and Terminology
The following data-elements are mandatory:
Each QuestionnaireResponse must have:
- A status *
- A link to the question being answered *
- A reference to the form being answered **
- A Patient **
- A datetime **
* Mandatory in the base FHIR QuestionnaireResponse resource
** Mandatory in the SDC implementation guide
The system Must Support if available:
- A contained patient resource
- Argonaut QuestionnaireResponse Response Period Extension to record the start and stop date-times for completing a questionnaire or a questionnnaire item or group
- A business identifier
- A reference to the envcounter
- Who or what recorded the answers
- Who answered the questions
- Nesting or grouping of answers tha correspond to the structure and grouping of the Questionnaire
- The text of the question
- The actual response to the question
Examples
- Sampler Response Response to the corresponding Sampler example
- Sampler Response with Contained Patient Response to the corresponding Sampler example with the subject reference as a contained patient
- PHQ-9 Response Response to the corresponding PHQ-9 example
- AUDIT-C Response Response to the corresponding AUDIT-C example
- DAST Response Response to the corresponding DAST example
- Housing Response Response to the corresponding Housing 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-questionnaireresponse
Published on Wed Apr 04 00:00:00 AEST 2018 as active by the Argonaut Project.
This profile builds on QuestionnaireResponse
Summary
Mandatory: 3 elements
Must-Support: 18 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
- http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
Extensions
This structure refers to these extensions:
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 | S | 0..1 | Reference(US Core Patient Profile) | Contained, inline Resources |
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 |
Summary
Mandatory: 3 elements
Must-Support: 18 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
- http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
Extensions
This structure refers to these extensions:
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 | S | 0..1 | Reference(US Core Patient Profile) | Contained, inline Resources |
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.
Static Forms Use Case:
Adaptive Forms Use Case:
-
The contained Argonaut Adaptive QuestionnaireResponse Profile is built on this profile.