FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

2.39 2.38 Resource QuestionnaireResponse - Content

FHIR Infrastructure Work Group Maturity Level : 3   Trial Use Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson

A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

2.39.1 2.38.1 Scope and Usage

QuestionnaireResponse provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire. The questions may be included directly or by reference to a Questionnaire resource that defines the questions as well as the constraints on the allowed answers. In some cases, both formal rules for editing the questionnaire (via link to Questionnaire ) as well as sufficient local information to allow rendering of the questionnaire may be provided.

Each time a questionnaire is completed for a different subject or at a different time, a distinct QuestionnaireResponse is generated, though it may be possible for a previously entered set of answers to be edited or updated.

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. Questionnaire responses record specifics about data capture - exactly what questions were asked, in what order, what answers were given, etc. Each of these questions is part of the Questionnaire, and as such the Questionnaire is a separately identifiable Resource, whereas the individual questions are not.

Examples of Questionnaires include:

  • Past medical history (PMH)
  • Family diseases
  • Social history
  • Research questionnaires and Case report forms (CRFs)
  • Quality and evaluation forms
  • Patient intake form (e.g. clipboard)
  • Insurance claim form

QuestionnaireResponse resources can be validated against their corresponding Questionnaire to verify that required groups and questions are answered and that answers fit constraints in terms of cardinality, data type, etc.

2.39.2 2.38.2 Boundaries and Relationships

The QuestionnaireResponse resource captures the responses to a questionnaire, while Questionnaire represents the definition of the questionnaire form, including what questions are asked, how they're organized and the constraints on the allowed answers.

While Observation , with its nested relatedObservation structure, can create complex hierarchies of questions and answers, the focus is different. First, Observation is used primarily for capturing data elements that are "true" "true" observations - lab measurements, vital signs, social assessments, etc., while QuestionnaireResponse can be used to capture any types of data, including data that would typically map to other resources ( Procedure , Patient , MedicationStatement , etc.). Second, the focus of QuestionnaireResponse includes the specific phrasing and organization of the questions. All data must be explicitly captured as a question. With Observation , the focus is only on the meaning of the answer, not what question was asked (assuming a question was even asked at all). Additional information such as normal ranges, interpretation, date, etc., may also be captured.

This resource is referenced by ClinicalImpression , Consent , Contract , DeviceUseStatement , FamilyMemberHistory and Observation

2.39.3 2.38.3 Resource Content

Structure

subject 0..1 Reference ( Any ) The subject this group's answers are about
Name Flags Card. Type Description & Constraints doco
. . QuestionnaireResponse TU DomainResource A structured set of questions and their answers
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..1 Identifier Unique id for this set of answers
. . . basedOn Σ 0..* Reference ( ReferralRequest | CarePlan | ProcedureRequest ServiceRequest ) Request fulfilled by this QuestionnaireResponse
. . . parent partOf Σ 0..* Reference ( Observation | Procedure ) Part of this action
. . . questionnaire Σ 0..1 Reference canonical ( Questionnaire ) Form being answered
. . . status ?! Σ 1..1 code in-progress | completed | amended | entered-in-error | stopped
QuestionnaireResponseStatus ( Required )
. . . subject Σ 0..1 Reference ( Any ) The subject of the questions
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or Episode during which questionnaire was completed
. . . authored Σ 0..1 dateTime Date the answers were gathered
. . . author Σ 0..1 Reference ( Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization ) Person who received and recorded the answers
. . . source Σ 0..1 Reference ( Patient | Practitioner | RelatedPerson ) The person who answered the questions
. . . item I 0..* BackboneElement Groups and questions
+ Rule: Nested item can't be beneath both item and answer
. . . . 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
. . . . . value[x] 0..1 Single-valued answer to the question
Questionnaire Answer Codes ( Example )
. . . . . . valueBoolean boolean
. . . . . . valueDecimal decimal
. . . . . . valueInteger integer
. . . . . . valueDate date
. . . . . . valueDateTime dateTime
. . . . . . valueTime time
. . . . . . valueString string
. . . . . . valueUri uri
. . . . . . valueAttachment Attachment
. . . . . . valueCoding Coding
. . . . . . valueQuantity Quantity
. . . . . . valueReference Reference ( Any )
. . . . . item 0..* see item Nested groups and questions
. . . . item 0..* see item Nested questionnaire response items

doco Documentation for this format

UML Diagram ( Legend )

QuestionnaireResponse ( DomainResource ) A business identifier assigned to a particular completed (or partially completed) questionnaire identifier : Identifier [0..1] The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression basedOn : Reference [0..*] ReferralRequest | « CarePlan | ProcedureRequest ServiceRequest » A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of parent partOf : Reference [0..*] « Observation | Procedure » The Questionnaire that defines and organizes the questions for which answers are being provided questionnaire : Reference canonical [0..1] « Questionnaire » The position of the questionnaire response within its overall lifecycle (this element modifies the meaning of other elements) status : code [1..1] « Lifecycle status of the questionnaire response. (Strength=Required) QuestionnaireResponseStatus ! » The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information subject : Reference [0..1] « Any » The encounter or episode of care with primary association to the questionnaire response context : Reference [0..1] « Encounter | EpisodeOfCare » The date and/or time that this set of answers were last changed authored : dateTime [0..1] Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system author : Reference [0..1] « Device | Practitioner | Patient PractitionerRole | Patient | RelatedPerson | Organization » The person who answered the questions about the subject source : Reference [0..1] « Patient | Practitioner | RelatedPerson » Item The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource linkId : string [1..1] A reference to an [[[ElementDefinition]]] that provides the details for the item definition : uri [0..1] Text that is displayed above the contents of the group or as the text of the question being answered text : string [0..1] More specific subject this section's answers are about, details the subject given in QuestionnaireResponse subject : Reference [0..1] Any Answer The answer (or one of the answers) provided by the respondent to the question value[x] : Type [0..1] « boolean | decimal | integer | date | dateTime | time | string | uri | Attachment | Coding | Quantity | Reference ( Any ); Code indicating the response provided for a question. (Strength=Example) Questionnaire Answer QuestionnaireAnswerCodes ?? » Nested groups and/or questions found within this particular answer item [0..*] The respondent's answer(s) to the question answer [0..*] Questions or sub-groups nested beneath a question or group item [0..*] A group or question item from the original questionnaire for which answers are provided item [0..*]

XML Template 

<

<QuestionnaireResponse xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Unique id for this set of answers --></identifier>
 <</basedOn>
 <</parent>
 <</questionnaire>
 <

 <basedOn><!-- 0..* Reference(CarePlan|ServiceRequest) Request fulfilled by this QuestionnaireResponse --></basedOn>
 <partOf><!-- 0..* Reference(Observation|Procedure) Part of this action --></partOf>
 <questionnaire><!-- 0..1 canonical(Questionnaire) Form being answered --></questionnaire>
 <status value="[code]"/><!-- 1..1 in-progress | completed | amended | entered-in-error | stopped -->

 <subject><!-- 0..1 Reference(Any) The subject of the questions --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which questionnaire was completed --></context>
 <
 <</author>

 <authored value="[dateTime]"/><!-- 0..1 Date the answers were gathered -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole|Patient|
   RelatedPerson|Organization) Person who received and recorded the answers --></author>
 <source><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson) The person who answered the questions --></source>
 <item>  <!-- 0..* Groups and questions -->
  <
  <
  <
  <</subject>

  <linkId value="[string]"/><!-- 1..1 Pointer to specific item from Questionnaire -->
  <definition value="[uri]"/><!-- 0..1 ElementDefinition - details for the item -->
  <text value="[string]"/><!-- 0..1 Name for group or question text -->

  <answer>  <!-- 0..* The response(s) to the question -->
   <value[x]><!-- 0..1 boolean|decimal|integer|date|dateTime|time|string|uri|
     Attachment|Coding|Quantity|Reference(Any) Single-valued answer to the question --></value[x]>
   <item><!-- 0..* Content as for QuestionnaireResponse.item Nested groups and questions --></item>
  </answer>
  <item><!-- 0..* Content as for QuestionnaireResponse.item Nested questionnaire response items --></item>
 </item>
</QuestionnaireResponse>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "QuestionnaireResponse",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "
    "

  "identifier" : { Identifier }, // Unique id for this set of answers
  "basedOn" : [{ Reference(CarePlan|ServiceRequest) }], // Request fulfilled by this QuestionnaireResponse
  "partOf" : [{ Reference(Observation|Procedure) }], // Part of this action
  "questionnaire" : { canonical(Questionnaire) }, // Form being answered
  "status" : "<code>", // R!  in-progress | completed | amended | entered-in-error | stopped
  "subject" : { Reference(Any) }, // The subject of the questions
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which questionnaire was completed
  "authored" : "<dateTime>", // Date the answers were gathered
  "author" : { Reference(Device|Practitioner|PractitionerRole|Patient|
   RelatedPerson|Organization) }, // Person who received and recorded the answers

  "source" : { Reference(Patient|Practitioner|RelatedPerson) }, // The person who answered the questions
  "item" : [{ // Groups and questions
    "linkId" : "<string>", // R!  Pointer to specific item from Questionnaire
    "definition" : "<uri>", // ElementDefinition - details for the item
    "text" : "<string>", // Name for group or question text
    "answer" : [{ // The response(s) to the question

      // value[x]: Single-valued answer to the question. One of these 12:
      ">,
      ">,
      ">,
      ">",
      ">",
      ">",
      ">",
      ">",
      " },
      " },
      " },
      " },
      "

      "valueBoolean" : <boolean>,
      "valueDecimal" : <decimal>,
      "valueInteger" : <integer>,
      "valueDate" : "<date>",
      "valueDateTime" : "<dateTime>",
      "valueTime" : "<time>",
      "valueString" : "<string>",
      "valueUri" : "<uri>",
      "valueAttachment" : { Attachment },
      "valueCoding" : { Coding },
      "valueQuantity" : { Quantity },
      "valueReference" : { Reference(Any) },
      "item" : [{ Content as for QuestionnaireResponse.item }] // Nested groups and questions

    }],
    "

    "item" : [{ Content as for QuestionnaireResponse.item }] // Nested questionnaire response items

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:QuestionnaireResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:QuestionnaireResponse.identifier [ Identifier ]; # 0..1 Unique id for this set of answers
  fhir:
  fhir:
  fhir:

  fhir:QuestionnaireResponse.basedOn [ Reference(CarePlan|ServiceRequest) ], ... ; # 0..* Request fulfilled by this QuestionnaireResponse
  fhir:QuestionnaireResponse.partOf [ Reference(Observation|Procedure) ], ... ; # 0..* Part of this action
  fhir:QuestionnaireResponse.questionnaire [ canonical(Questionnaire) ]; # 0..1 Form being answered

  fhir:QuestionnaireResponse.status [ code ]; # 1..1 in-progress | completed | amended | entered-in-error | stopped
  fhir:QuestionnaireResponse.subject [ Reference(Any) ]; # 0..1 The subject of the questions
  fhir:QuestionnaireResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which questionnaire was completed
  fhir:QuestionnaireResponse.authored [ dateTime ]; # 0..1 Date the answers were gathered
  fhir:

  fhir:QuestionnaireResponse.author [ Reference(Device|Practitioner|PractitionerRole|Patient|RelatedPerson|Organization) ]; # 0..1 Person who received and recorded the answers

  fhir:QuestionnaireResponse.source [ Reference(Patient|Practitioner|RelatedPerson) ]; # 0..1 The person who answered the questions
  fhir:QuestionnaireResponse.item [ # 0..* Groups and questions
    fhir:QuestionnaireResponse.item.linkId [ string ]; # 1..1 Pointer to specific item from Questionnaire
    fhir:QuestionnaireResponse.item.definition [ uri ]; # 0..1 ElementDefinition - details for the item
    fhir:QuestionnaireResponse.item.text [ string ]; # 0..1 Name for group or question text
    fhir:

    fhir:QuestionnaireResponse.item.answer [ # 0..* The response(s) to the question
      # QuestionnaireResponse.item.answer.value[x] : 0..1 Single-valued answer to the question. One of these 12
        fhir:QuestionnaireResponse.item.answer.valueBoolean [ boolean ]
        fhir:QuestionnaireResponse.item.answer.valueDecimal [ decimal ]
        fhir:QuestionnaireResponse.item.answer.valueInteger [ integer ]
        fhir:QuestionnaireResponse.item.answer.valueDate [ date ]
        fhir:QuestionnaireResponse.item.answer.valueDateTime [ dateTime ]
        fhir:QuestionnaireResponse.item.answer.valueTime [ time ]
        fhir:QuestionnaireResponse.item.answer.valueString [ string ]
        fhir:QuestionnaireResponse.item.answer.valueUri [ uri ]
        fhir:QuestionnaireResponse.item.answer.valueAttachment [ Attachment ]
        fhir:QuestionnaireResponse.item.answer.valueCoding [ Coding ]
        fhir:QuestionnaireResponse.item.answer.valueQuantity [ Quantity ]
        fhir:QuestionnaireResponse.item.answer.valueReference [ Reference(Any) ]
      fhir:QuestionnaireResponse.item.answer.item [ See QuestionnaireResponse.item ], ... ; # 0..* Nested groups and questions
    ], ...;
    fhir:QuestionnaireResponse.item.item [ See QuestionnaireResponse.item ], ... ; # 0..* Nested questionnaire response items
  ], ...;
]

Changes since DSTU2 R3

QuestionnaireResponse
QuestionnaireResponse.basedOn
  • Added Element Type changed from Reference(ReferralRequest|CarePlan|ProcedureRequest) to Reference(CarePlan|ServiceRequest)
QuestionnaireResponse.parent QuestionnaireResponse.partOf
  • Added Element
QuestionnaireResponse.context Renamed from encounter to context Add Reference(EpisodeOfCare) QuestionnaireResponse.item QuestionnaireResponse.questionnaire
  • Renamed from group to item Max Cardinality Type changed from 1 Reference(Questionnaire) to * canonical
QuestionnaireResponse.item.linkId QuestionnaireResponse.author
  • Min Cardinality Type changed from 0 Reference(Device|Practitioner|Patient|RelatedPerson) to 1 QuestionnaireResponse.item.definition Added Element QuestionnaireResponse.item.answer Added Element Reference(Device|Practitioner|PractitionerRole|Patient|RelatedPerson|Organization)
QuestionnaireResponse.item.answer.value[x]
  • Added Element QuestionnaireResponse.item.answer.item Added Element QuestionnaireResponse.item.item Added Element QuestionnaireResponse.group.title deleted Remove Reference(Resource), Add Reference(Resource)
QuestionnaireResponse.group.group QuestionnaireResponse.parent
  • deleted
QuestionnaireResponse.group.question QuestionnaireResponse.item.subject
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 6 5 tests that all of which 1 fail to execute ok. . 1 4 fail round-trip testing and 6 4 r3 resources are invalid (19 (0 errors). ). )

Structure

subject 0..1 Reference ( Any ) The subject this group's answers are about
Name Flags Card. Type Description & Constraints doco
. . QuestionnaireResponse TU DomainResource A structured set of questions and their answers
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..1 Identifier Unique id for this set of answers
. . . basedOn Σ 0..* Reference ( ReferralRequest | CarePlan | ProcedureRequest ServiceRequest ) Request fulfilled by this QuestionnaireResponse
. . . parent partOf Σ 0..* Reference ( Observation | Procedure ) Part of this action
. . . questionnaire Σ 0..1 Reference canonical ( Questionnaire ) Form being answered
. . . status ?! Σ 1..1 code in-progress | completed | amended | entered-in-error | stopped
QuestionnaireResponseStatus ( Required )
. . . subject Σ 0..1 Reference ( Any ) The subject of the questions
. . . context Σ 0..1 Reference ( Encounter | EpisodeOfCare ) Encounter or Episode during which questionnaire was completed
. . . authored Σ 0..1 dateTime Date the answers were gathered
. . . author Σ 0..1 Reference ( Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization ) Person who received and recorded the answers
. . . source Σ 0..1 Reference ( Patient | Practitioner | RelatedPerson ) The person who answered the questions
. . . item I 0..* BackboneElement Groups and questions
+ Rule: Nested item can't be beneath both item and answer
. . . . 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
. . . . . value[x] 0..1 Single-valued answer to the question
Questionnaire Answer Codes ( Example )
. . . . . . valueBoolean boolean
. . . . . . valueDecimal decimal
. . . . . . valueInteger integer
. . . . . . valueDate date
. . . . . . valueDateTime dateTime
. . . . . . valueTime time
. . . . . . valueString string
. . . . . . valueUri uri
. . . . . . valueAttachment Attachment
. . . . . . valueCoding Coding
. . . . . . valueQuantity Quantity
. . . . . . valueReference Reference ( Any )
. . . . . item 0..* see item Nested groups and questions
. . . . item 0..* see item Nested questionnaire response items

doco Documentation for this format

UML Diagram ( Legend )

QuestionnaireResponse ( DomainResource ) A business identifier assigned to a particular completed (or partially completed) questionnaire identifier : Identifier [0..1] The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression basedOn : Reference [0..*] ReferralRequest | « CarePlan | ProcedureRequest ServiceRequest » A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of parent partOf : Reference [0..*] « Observation | Procedure » The Questionnaire that defines and organizes the questions for which answers are being provided questionnaire : Reference canonical [0..1] « Questionnaire » The position of the questionnaire response within its overall lifecycle (this element modifies the meaning of other elements) status : code [1..1] « Lifecycle status of the questionnaire response. (Strength=Required) QuestionnaireResponseStatus ! » The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information subject : Reference [0..1] « Any » The encounter or episode of care with primary association to the questionnaire response context : Reference [0..1] « Encounter | EpisodeOfCare » The date and/or time that this set of answers were last changed authored : dateTime [0..1] Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system author : Reference [0..1] « Device | Practitioner | Patient PractitionerRole | Patient | RelatedPerson | Organization » The person who answered the questions about the subject source : Reference [0..1] « Patient | Practitioner | RelatedPerson » Item The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource linkId : string [1..1] A reference to an [[[ElementDefinition]]] that provides the details for the item definition : uri [0..1] Text that is displayed above the contents of the group or as the text of the question being answered text : string [0..1] More specific subject this section's answers are about, details the subject given in QuestionnaireResponse subject : Reference [0..1] Any Answer The answer (or one of the answers) provided by the respondent to the question value[x] : Type [0..1] « boolean | decimal | integer | date | dateTime | time | string | uri | Attachment | Coding | Quantity | Reference ( Any ); Code indicating the response provided for a question. (Strength=Example) Questionnaire Answer QuestionnaireAnswerCodes ?? » Nested groups and/or questions found within this particular answer item [0..*] The respondent's answer(s) to the question answer [0..*] Questions or sub-groups nested beneath a question or group item [0..*] A group or question item from the original questionnaire for which answers are provided item [0..*]

XML Template 

<

<QuestionnaireResponse xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Unique id for this set of answers --></identifier>
 <</basedOn>
 <</parent>
 <</questionnaire>
 <

 <basedOn><!-- 0..* Reference(CarePlan|ServiceRequest) Request fulfilled by this QuestionnaireResponse --></basedOn>
 <partOf><!-- 0..* Reference(Observation|Procedure) Part of this action --></partOf>
 <questionnaire><!-- 0..1 canonical(Questionnaire) Form being answered --></questionnaire>
 <status value="[code]"/><!-- 1..1 in-progress | completed | amended | entered-in-error | stopped -->

 <subject><!-- 0..1 Reference(Any) The subject of the questions --></subject>
 <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Encounter or Episode during which questionnaire was completed --></context>
 <
 <</author>

 <authored value="[dateTime]"/><!-- 0..1 Date the answers were gathered -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole|Patient|
   RelatedPerson|Organization) Person who received and recorded the answers --></author>
 <source><!-- 0..1 Reference(Patient|Practitioner|RelatedPerson) The person who answered the questions --></source>
 <item>  <!-- 0..* Groups and questions -->
  <
  <
  <
  <</subject>

  <linkId value="[string]"/><!-- 1..1 Pointer to specific item from Questionnaire -->
  <definition value="[uri]"/><!-- 0..1 ElementDefinition - details for the item -->
  <text value="[string]"/><!-- 0..1 Name for group or question text -->

  <answer>  <!-- 0..* The response(s) to the question -->
   <value[x]><!-- 0..1 boolean|decimal|integer|date|dateTime|time|string|uri|
     Attachment|Coding|Quantity|Reference(Any) Single-valued answer to the question --></value[x]>
   <item><!-- 0..* Content as for QuestionnaireResponse.item Nested groups and questions --></item>
  </answer>
  <item><!-- 0..* Content as for QuestionnaireResponse.item Nested questionnaire response items --></item>
 </item>
</QuestionnaireResponse>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "QuestionnaireResponse",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "
    "

  "identifier" : { Identifier }, // Unique id for this set of answers
  "basedOn" : [{ Reference(CarePlan|ServiceRequest) }], // Request fulfilled by this QuestionnaireResponse
  "partOf" : [{ Reference(Observation|Procedure) }], // Part of this action
  "questionnaire" : { canonical(Questionnaire) }, // Form being answered
  "status" : "<code>", // R!  in-progress | completed | amended | entered-in-error | stopped
  "subject" : { Reference(Any) }, // The subject of the questions
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or Episode during which questionnaire was completed
  "authored" : "<dateTime>", // Date the answers were gathered
  "author" : { Reference(Device|Practitioner|PractitionerRole|Patient|
   RelatedPerson|Organization) }, // Person who received and recorded the answers

  "source" : { Reference(Patient|Practitioner|RelatedPerson) }, // The person who answered the questions
  "item" : [{ // Groups and questions
    "linkId" : "<string>", // R!  Pointer to specific item from Questionnaire
    "definition" : "<uri>", // ElementDefinition - details for the item
    "text" : "<string>", // Name for group or question text
    "answer" : [{ // The response(s) to the question

      // value[x]: Single-valued answer to the question. One of these 12:
      ">,
      ">,
      ">,
      ">",
      ">",
      ">",
      ">",
      ">",
      " },
      " },
      " },
      " },
      "

      "valueBoolean" : <boolean>,
      "valueDecimal" : <decimal>,
      "valueInteger" : <integer>,
      "valueDate" : "<date>",
      "valueDateTime" : "<dateTime>",
      "valueTime" : "<time>",
      "valueString" : "<string>",
      "valueUri" : "<uri>",
      "valueAttachment" : { Attachment },
      "valueCoding" : { Coding },
      "valueQuantity" : { Quantity },
      "valueReference" : { Reference(Any) },
      "item" : [{ Content as for QuestionnaireResponse.item }] // Nested groups and questions

    }],
    "

    "item" : [{ Content as for QuestionnaireResponse.item }] // Nested questionnaire response items

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:QuestionnaireResponse;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:QuestionnaireResponse.identifier [ Identifier ]; # 0..1 Unique id for this set of answers
  fhir:
  fhir:
  fhir:

  fhir:QuestionnaireResponse.basedOn [ Reference(CarePlan|ServiceRequest) ], ... ; # 0..* Request fulfilled by this QuestionnaireResponse
  fhir:QuestionnaireResponse.partOf [ Reference(Observation|Procedure) ], ... ; # 0..* Part of this action
  fhir:QuestionnaireResponse.questionnaire [ canonical(Questionnaire) ]; # 0..1 Form being answered

  fhir:QuestionnaireResponse.status [ code ]; # 1..1 in-progress | completed | amended | entered-in-error | stopped
  fhir:QuestionnaireResponse.subject [ Reference(Any) ]; # 0..1 The subject of the questions
  fhir:QuestionnaireResponse.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Encounter or Episode during which questionnaire was completed
  fhir:QuestionnaireResponse.authored [ dateTime ]; # 0..1 Date the answers were gathered
  fhir:

  fhir:QuestionnaireResponse.author [ Reference(Device|Practitioner|PractitionerRole|Patient|RelatedPerson|Organization) ]; # 0..1 Person who received and recorded the answers

  fhir:QuestionnaireResponse.source [ Reference(Patient|Practitioner|RelatedPerson) ]; # 0..1 The person who answered the questions
  fhir:QuestionnaireResponse.item [ # 0..* Groups and questions
    fhir:QuestionnaireResponse.item.linkId [ string ]; # 1..1 Pointer to specific item from Questionnaire
    fhir:QuestionnaireResponse.item.definition [ uri ]; # 0..1 ElementDefinition - details for the item
    fhir:QuestionnaireResponse.item.text [ string ]; # 0..1 Name for group or question text
    fhir:

    fhir:QuestionnaireResponse.item.answer [ # 0..* The response(s) to the question
      # QuestionnaireResponse.item.answer.value[x] : 0..1 Single-valued answer to the question. One of these 12
        fhir:QuestionnaireResponse.item.answer.valueBoolean [ boolean ]
        fhir:QuestionnaireResponse.item.answer.valueDecimal [ decimal ]
        fhir:QuestionnaireResponse.item.answer.valueInteger [ integer ]
        fhir:QuestionnaireResponse.item.answer.valueDate [ date ]
        fhir:QuestionnaireResponse.item.answer.valueDateTime [ dateTime ]
        fhir:QuestionnaireResponse.item.answer.valueTime [ time ]
        fhir:QuestionnaireResponse.item.answer.valueString [ string ]
        fhir:QuestionnaireResponse.item.answer.valueUri [ uri ]
        fhir:QuestionnaireResponse.item.answer.valueAttachment [ Attachment ]
        fhir:QuestionnaireResponse.item.answer.valueCoding [ Coding ]
        fhir:QuestionnaireResponse.item.answer.valueQuantity [ Quantity ]
        fhir:QuestionnaireResponse.item.answer.valueReference [ Reference(Any) ]
      fhir:QuestionnaireResponse.item.answer.item [ See QuestionnaireResponse.item ], ... ; # 0..* Nested groups and questions
    ], ...;
    fhir:QuestionnaireResponse.item.item [ See QuestionnaireResponse.item ], ... ; # 0..* Nested questionnaire response items
  ], ...;
]

Changes since DSTU2 Release 3

QuestionnaireResponse
QuestionnaireResponse.basedOn
  • Added Element Type changed from Reference(ReferralRequest|CarePlan|ProcedureRequest) to Reference(CarePlan|ServiceRequest)
QuestionnaireResponse.parent QuestionnaireResponse.partOf
  • Added Element
QuestionnaireResponse.context Renamed from encounter to context Add Reference(EpisodeOfCare) QuestionnaireResponse.item QuestionnaireResponse.questionnaire
  • Renamed from group to item Max Cardinality Type changed from 1 Reference(Questionnaire) to * canonical
QuestionnaireResponse.item.linkId QuestionnaireResponse.author
  • Min Cardinality Type changed from 0 Reference(Device|Practitioner|Patient|RelatedPerson) to 1 QuestionnaireResponse.item.definition Added Element QuestionnaireResponse.item.answer Added Element Reference(Device|Practitioner|PractitionerRole|Patient|RelatedPerson|Organization)
QuestionnaireResponse.item.answer.value[x]
  • Added Element QuestionnaireResponse.item.answer.item Added Element QuestionnaireResponse.item.item Added Element QuestionnaireResponse.group.title deleted Remove Reference(Resource), Add Reference(Resource)
QuestionnaireResponse.group.group QuestionnaireResponse.parent
  • deleted
QuestionnaireResponse.group.question QuestionnaireResponse.item.subject
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 6 5 tests that all of which 1 fail to execute ok. . 1 4 fail round-trip testing and 6 4 r3 resources are invalid (19 (0 errors). ). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

2.39.3.1 2.38.3.1 Terminology Bindings

Path Definition Type Reference
QuestionnaireResponse.status Lifecycle status of the questionnaire response. Required QuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x] Code indicating the response provided for a question. Example Questionnaire Answer Codes QuestionnaireAnswerCodes

2.39.3.2 2.38.3.2 Constraints

id Level Location Description Expression
qrs-1 : On QuestionnaireResponse.item: Rule QuestionnaireResponse.item Nested item can't be beneath both item and answer ( expression on QuestionnaireResponse.item: (answer.exists() and item.exists()).not() )

2.39.4 2.38.4 Notes

  • QuestionnaireResponses can be authored by clinicians, patients, or patients' relatives (or even owners in the case of animals). Clinicians may author questionnaire responses, where the answers are provided by others on behalf of the patient. Additionally, information gathered on behalf of a patient may be about the patient's relatives (e.g. in family anamnesis). Therefore, QuestionnaireResponse makes a distinction between the author, the subject and the source of information.
  • A QuestionnaireResponse may be stand-alone or may point to the form that defines the questions in Questionnaire . In this second case, the linkage between the questions and groups in the two resources is established using the linkId element. If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.) Because of the lack of explicit support for Questionnaires in HL7 v3 , CDA Documents frequently used named sections with Observations to model questionnaires. Such use cases should now utilize the QuestionnaireResponse resource instead. The QuestionnaireResponse's encounter element can be used to link to the encounter when the questionnaire response was authored. This can be relevant since the encounter gives context to the answers and can be used to relate information in the QuestionnaireResponse to orders and observations that were done during the same Encounter.
  • The QuestionnaireResponse's language element can be used to indicte the language in which the patient completed the survey/questionnaire
  • The order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture. The hierarchy items within the Questionnaire SHALL mirror the hierarchy of the corresponding Questionnaire (if any).
  • Typically For use of QuestionnaireResponse.item.definition, see notes on Questionnaire items
  • Because of type display are not mirrored in a QuestionnaireResponse as the purpose lack of a QuestionnaireResponse is to reflect the information entered into the form, not the instructions provided, though questions and group headings are retained explicit support for Questionnaires in HL7 v3 , CDA Documents frequently used named sections with Observations to ensure that the meaning of answers can be interpreted independent of model questionnaires. Such use cases should now utilize the Questionnaire. QuestionnaireResponse resource instead.

Refer to additional guidance provided in the Questionnaire resource dealing with the design of questionnaires.

2.38.4.1 Links to Questionnaire

A QuestionnaireResponse may be stand-alone or may point to the definition of the questions in Questionnaire . If the QuestionnaireResponse refers to a Questionnaire:

  • The QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.
  • The linkage between the questions and groups in the two resources is established using the linkId element
  • When a QuestionnaireResponse references a Questionnaire, all the items in the questionnaire SHOULD be included in the QuestionnaireResponse if they are relevant to the interpretation of the answers, including items of type = display . This might also include items that were >not enabled when the Questionnaire was answered, though of course these will not have answers

2.39.5 2.38.4.2 Security

QuestionnaireResponse resources can have answers with values of type Attachment. These attachments will typically be selected by the user answering the questionnaire and this selection may be done in an uncontrolled environment. Systems should ensure that the attachment is of the desired type and should take precautions before rendering or executing any attached content.

2.39.6 2.38.4.3 Access Control

For most resources, the type of information that can be conveyed in the resource is determined by the resource, and the key attributes that determine the sensitivity level of the information are also known; e.g., drug, observation type, clinical trial randomization status, etc. However, for QuestionnaireResponse, the sensitivity of an instance is dependent on what type of Questionnaire it is associated with. And the data elements that determine that sensitivity could be the answers to any of the questions. This makes automatically enforcing access control rules more challenging. Designers should take these challenges into account and may need to place stricter access controls around QuestionnaireResponse to ensure that access to information is not granted improperly.

2.39.7 2.38.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
author reference The author of the questionnaire response QuestionnaireResponse.author
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson )
authored date When the questionnaire response was last changed QuestionnaireResponse.authored
based-on reference Plan/proposal/order fulfilled by this questionnaire response QuestionnaireResponse.basedOn
( ReferralRequest , CarePlan , ProcedureRequest ServiceRequest )
context reference Encounter or episode associated with the questionnaire response QuestionnaireResponse.context
( EpisodeOfCare , Encounter )
identifier token The unique identifier for the questionnaire response QuestionnaireResponse.identifier
parent part-of reference Procedure or observation this questionnaire response was performed as a part of QuestionnaireResponse.parent QuestionnaireResponse.partOf
( Observation , Procedure )
patient reference The patient that is the subject of the questionnaire response QuestionnaireResponse.subject QuestionnaireResponse.subject.where(resolve() is Patient)
( Patient )
questionnaire reference The questionnaire the answers are provided for QuestionnaireResponse.questionnaire
( Questionnaire )
source reference The individual providing the information reflected in the questionnaire respose QuestionnaireResponse.source
( Practitioner , Patient , RelatedPerson )
status token The status of the questionnaire response QuestionnaireResponse.status
subject reference The subject of the questionnaire response QuestionnaireResponse.subject
(Any)