Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.athena.io/StructureDefinition/ah-questionnaireresponse | Version: 4.2.0 | |||
| Active as of 2025-04-17 | Computable Name: AthenahealthQuestionnaireResponse | |||
| Keywords: Wire Format | ||||
QuestionnaireResponse provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire.
Questionnaire responses cover the need to communicate data originating from forms used in medical history examinations, research questionnaires and sometimes full clinical specialty records. In many systems this data is collected using user-defined screens and forms. (i.e. GET [fhir base]/QuestionnaireResponse/[id]/ where [id] is a custom or practice-level question ID’) to obtain a detailed set of FHIR resources.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  QuestionnaireResponse |
0..* | QuestionnaireResponse | A structured set of questions and their answers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  id |
Σ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:ahChartSharingGroup |
0..1 | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:ahPractice |
1..1 | Reference(Organization) | athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 extension:ahScreenerScore |
1..1 | string | athenahealth screener score Search URL: https://fhir.athena.io/StructureDefinition/ah-questionnaire-response-screener ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. ele-1: All FHIR elements must have a @value or children |
 subject |
Σ | 0..1 | Reference(Patient) | The subject of the questions ele-1: All FHIR elements must have a @value or children |
 author |
Σ | 0..1 | Reference(Organization) | Person who received and recorded the answers ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
0..* | QuestionnaireResponse | A structured set of questions and their answers | |||||
| id |
Σ | 1..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahChartSharingGroup |
0..1 | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |||||
| extension:ahPractice |
1..1 | Reference(Organization) | athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice | |||||
| extension:ahScreenerScore |
1..1 | string | athenahealth screener score Search URL: https://fhir.athena.io/StructureDefinition/ah-questionnaire-response-screener | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..1 | Identifier | Unique id for this set of answers | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
| partOf |
Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
| questionnaire |
Σ | 0..1 | canonical(Questionnaire) | Form being answered | ||||
| status |
?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject |
Σ | 0..1 | Reference(Patient) | The subject of the questions | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored |
Σ | 0..1 | dateTime | Date the answers were gathered | ||||
| author |
Σ | 0..1 | Reference(Organization) | Person who received and recorded the answers | ||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
 item |
C | 0..* | BackboneElement | Groups and questions qrs-1: Nested item can't be beneath both item and answer | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| text |
0..1 | string | Name for group or question text | |||||
| answer |
0..* | BackboneElement | The response(s) to the question | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
 Slices for value[x] |
0..1 | Single-valued answer to the question Slice: Unordered, Open by type:$this Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| value[x]:valueString |
0..1 | string | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| value[x]:valueCoding |
0..1 | Coding | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
 item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| QuestionnaireResponse.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| QuestionnaireResponse.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| QuestionnaireResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x]:valueString | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x]:valueCoding | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
This structure is derived from QuestionnaireResponse
Summary
Mandatory: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from QuestionnaireResponse
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse |
0..* | QuestionnaireResponse | A structured set of questions and their answers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| id |
Σ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:ahChartSharingGroup |
0..1 | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:ahPractice |
1..1 | Reference(Organization) | athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:ahScreenerScore |
1..1 | string | athenahealth screener score Search URL: https://fhir.athena.io/StructureDefinition/ah-questionnaire-response-screener ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 0..1 | Reference(Patient) | The subject of the questions ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 0..1 | Reference(Organization) | Person who received and recorded the answers ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
0..* | QuestionnaireResponse | A structured set of questions and their answers | |||||
| id |
Σ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ahChartSharingGroup |
0..1 | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |||||
| extension:ahPractice |
1..1 | Reference(Organization) | athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice | |||||
| extension:ahScreenerScore |
1..1 | string | athenahealth screener score Search URL: https://fhir.athena.io/StructureDefinition/ah-questionnaire-response-screener | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..1 | Identifier | Unique id for this set of answers | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | Request fulfilled by this QuestionnaireResponse | ||||
| partOf |
Σ | 0..* | Reference(Observation | Procedure) | Part of this action | ||||
| questionnaire |
Σ | 0..1 | canonical(Questionnaire) | Form being answered | ||||
| status |
?!Σ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
| subject |
Σ | 0..1 | Reference(Patient) | The subject of the questions | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| authored |
Σ | 0..1 | dateTime | Date the answers were gathered | ||||
| author |
Σ | 0..1 | Reference(Organization) | Person who received and recorded the answers | ||||
| source |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
| item |
C | 0..* | BackboneElement | Groups and questions qrs-1: Nested item can't be beneath both item and answer | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| text |
0..1 | string | Name for group or question text | |||||
| answer |
0..* | BackboneElement | The response(s) to the question | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| Slices for value[x] |
0..1 | Single-valued answer to the question Slice: Unordered, Open by type:$this Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| value[x]:valueString |
0..1 | string | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| value[x]:valueCoding |
0..1 | Coding | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
| item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| QuestionnaireResponse.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| QuestionnaireResponse.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| QuestionnaireResponse.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| QuestionnaireResponse.status | required | QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1from the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x]:valueString | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| QuestionnaireResponse.item.answer.value[x]:valueCoding | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
This structure is derived from QuestionnaireResponse
Summary
Mandatory: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron