US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse | Version: 10.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USCoreQuestionnaireResponseProfile | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.56 | ||||
The US Core QuestionnaireResponse Profile inherits from the Structured Data Capture (SDC) Questionnaire Response Profile. This profile sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch the responses to form/survey and assessment tools such as the Protocol for Responding to and Assessing Patients\u2019 Assets, Risks, and Experiences (PRAPARE) Survey. It specifies which core additional elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Before reviewing this profile, implementers are encouraged to read the Screening and Assessments guidance page, which documents the process of recording responses and capturing assertions/determinations resulting from surveys and questionnaires.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
In addition to the Mandatory and Must Support data elements in the SDC QuestionnaireResponse Profile, the following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements. Note that the Key Elements Table view aggregates all the Must Support elements between this profile and its parent profiles.
Each QuestionnaireResponse Must Have:
Each QuestionnaireResponse Must Support:
1 see guidance below
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
QuestionnaireResponse.author and QuestionnaireResponse.source communicate the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 9.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2, sdcqr-3 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 Slices for extension |
Content/Rules for all slices | |||
   extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |
   extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |
  value[x] |
1..1 | Value of extension | ||
  valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||
 valueUri |
uri | |||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |
| value[x] |
1..1 | Value of extension | ||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||
| valueUri |
uri | |||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
 extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..1 | Identifier | Unique id for this set of answers | |
| questionnaire |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:questionnaireDisplay |
0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | |
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | |
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |
| authored |
1..1 | dateTime | Date the answers were gathered | |
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |
| item |
C | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |
| text |
0..1 | string | Name for group or question text | |
| answer |
0..* | BackboneElement | The response(s) to the question | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||
| valueBoolean |
boolean | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueUri |
uri | |||
| valueQuantity |
Quantity | |||
| valueAttachment |
Attachment | |||
| valueReference |
Reference(Any) | |||
 item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from SDCQuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
| questionnaire |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped | |
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |
| authored |
1..1 | dateTime | Date the answers were gathered | |
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |
| item |
0..* | BackboneElement | Groups and questions | |
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |
| answer |
||||
| value[x] |
0..1 | Single-valued answer to the question | ||
| valueBoolean |
boolean | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueUri |
uri | |||
| valueQuantity |
Quantity | |||
| valueAttachment |
Attachment | |||
| valueReference |
Reference(Any) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||
| value[x] |
1..1 | Value of extension | ||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||
| valueUri |
uri | |||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||
| value[x] |
1..1 | Value of extension | ||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||
| valueUri |
uri | |||||||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||
| 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 |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:questionnaireDisplay |
0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | |||||
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | |||||
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| authored |
1..1 | dateTime | Date the answers were gathered | |||||
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |||||
| source |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:r5Source |
0..1 | (Complex) | Alternative reference (target type is wrong) URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/alternate-reference" | |||||
| value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| item |
C | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
| valueBoolean |
boolean | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueUri |
uri | |||||||
| valueQuantity |
Quantity | |||||||
| valueAttachment |
Attachment | |||||||
| valueReference |
Reference(Any) | |||||||
| item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from SDCQuestionnaireResponse
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2, sdcqr-3 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |
| value[x] |
1..1 | Value of extension | ||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||
| valueUri |
uri | |||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |
| value[x] |
1..1 | Value of extension | ||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||
| valueUri |
uri | |||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..1 | Identifier | Unique id for this set of answers | |
| questionnaire |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:questionnaireDisplay |
0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | |
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | |
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |
| authored |
1..1 | dateTime | Date the answers were gathered | |
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |
| item |
C | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |
| text |
0..1 | string | Name for group or question text | |
| answer |
0..* | BackboneElement | The response(s) to the question | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||
| valueBoolean |
boolean | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueUri |
uri | |||
| valueQuantity |
Quantity | |||
| valueAttachment |
Attachment | |||
| valueReference |
Reference(Any) | |||
| item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from SDCQuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| QuestionnaireResponse |
0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse | |
| questionnaire |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped | |
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |
| authored |
1..1 | dateTime | Date the answers were gathered | |
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |
| item |
0..* | BackboneElement | Groups and questions | |
| linkId |
1..1 | string | Pointer to specific item from Questionnaire | |
| answer |
||||
| value[x] |
0..1 | Single-valued answer to the question | ||
| valueBoolean |
boolean | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueUri |
uri | |||
| valueQuantity |
Quantity | |||
| valueAttachment |
Attachment | |||
| valueReference |
Reference(Any) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| QuestionnaireResponse |
C | 0..* | SDCQuestionnaireResponse | US Core Profile based on SDC QuestionnaireResponse Constraints: sdcqr-1, sdcqr-2, sdcqr-3 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:adheresTo |
0..* | (Complex) | Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-adheresTo" | |||||
| value[x] |
1..1 | Value of extension | ||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||
| valueUri |
uri | |||||||
| extension:triggeredBy |
0..1 | (Complex) | Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" | |||||
| value[x] |
1..1 | Value of extension | ||||||
| valueCanonical |
canonical(ActivityDefinition | PlanDefinition) | |||||||
| valueReference |
Reference(ActivityDefinition | PlanDefinition) | |||||||
| valueUri |
uri | |||||||
| extension:signature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| extension:completionMode |
0..1 | CodeableConcept | E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed. | |||||
| 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 |
1..1 | canonical(SDC Base Questionnaire) | Form being answered | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:questionnaireDisplay |
0..1 | string | Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display | |||||
| extension:url |
0..1 | uri | The location where a non-FHIR questionnaire/survey form can be found. URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-extension-questionnaire-uri | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| status |
1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | |||||
| subject |
1..1 | Reference(US Core Patient Profile | Resource) | The subject of the questions | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| authored |
1..1 | dateTime | Date the answers were gathered | |||||
| author |
0..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core Device Profile | US Core RelatedPerson Profile) | Person who received and recorded the answers | |||||
| source |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:r5Source |
0..1 | (Complex) | Alternative reference (target type is wrong) URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/alternate-reference" | |||||
| value[x] |
1..1 | Reference(Device | Organization) | Value of extension | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| item |
C | 0..* | BackboneElement | Groups and questions Constraints: qrs-1, qrs-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| extension:ItemSignature |
0..* | Signature | A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| extension:itemWeight |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | ||||||
| valueBoolean |
boolean | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueUri |
uri | |||||||
| valueQuantity |
Quantity | |||||||
| valueAttachment |
Attachment | |||||||
| valueReference |
Reference(Any) | |||||||
| item |
0..* | See item (QuestionnaireResponse) | Nested groups and questions | |||||
| item |
0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| QuestionnaireResponse.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.status | Base | required | QuestionnaireResponseStatus | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| QuestionnaireResponse.item.answer.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from SDCQuestionnaireResponse
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to completed questionnnaire, survey and assessement data SHALL support these US Core SMART Scopes:
<patient|user|system>/QuestionnaireResponse.rs §The following search parameters and search parameter combinations SHALL be supported:
SHALL support both read QuestionnaireResponse by id AND QuestionnaireResponse search using the _id search parameter
GET [base]/QuestionnaireResponse?_id=[id]' or 'GET [base]/QuestionnaireResponse/[id]
Examples:
GET [base]/!QuestionnaireResponse/AHC-HRSN-screening-example
GET [base]/!QuestionnaireResponse/?_id=AHC-HRSN-screening-example
Implementation Notes: Fetches a US Core QuestionnaireResponse Profile resource or a search Bundle containing a US Core QuestionnaireResponse Profile resource matching the id (see Parameters for all resources).
SHALL support searching for all questionnaireresponses for a patient using the patient search parameter
GET [base]/QuestionnaireResponse?patient={Patient/}[id]
Example:
- GET [base]/QuestionnaireResponse?patient=Patient/1137192&
Implementation Notes: Fetches a bundle of all US Core QuestionnaireResponse Profile resources for the specified patient ( see how to search by reference).
The following search parameters and search parameter combinations SHOULD be supported
SHOULD combo description field using the combination of the patient and status search parameters
status (e.g.status={system|}[code],{system|}[code],...)GET [base]/QuestionnaireResponse?patient={Patient/}[id]&status={system|}[search_code]{,{system|}[code],...}
Example:
- GET [base]/QuestionnaireResponse?patient=Patient/1137192&status=completed
Implementation Notes: Fetches a bundle of all US Core QuestionnaireResponse Profile resources for the specified patient and status ( see how to search by reference and how to search by token).
SHOULD combo description field using the combination of the patient and authored search parameters
Including optional support for AND search on authored (e.g.authored=[date]&authored=[date]&...)
Including support for these authored comparators: "gt", "lt", "ge", "le"
GET [base]/QuestionnaireResponse?patient={Patient/}[id]&authored={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}
Example:
- GET [base]/QuestionnaireResponse?patient=Patient/1137192&date=ge2021
Implementation Notes: Fetches a bundle of all US Core QuestionnaireResponse Profile resources for the specified patient and date ( see how to search by reference).
SHOULD combo description field using the combination of the patient and questionnaire search parameters
GET [base]/QuestionnaireResponse?patient={Patient/}[id]&questionnaire={Type/}[id]
Example:
- GET [base]/QuestionnaireResponse?patient=Patient/1137192&questionnaire=http://hl7.org/fhir/us/sdoh-clinicalcare/Questionnaire/SDOHCC-QuestionnaireHungerVitalSign
Implementation Notes: Fetches a bundle of all US Core QuestionnaireResponse Profile resources for the specified patient that have been completed against a specified form. ( see how to search by reference).
Searching a patient's QuestionnaireResponses by specific context such as those defined in US Core Category can be achieved by querying the metadata on the associated Questionnaire. Specifically, Questionnaire.useContext with a code="focus" and value of "sdoh"/"functionalStatus"/etc. could be accomplished using a chained search:
GET [base]/QuestionnaireResponse?subject=Patient/123&questionnaire.context-type-value=focus$sdoh
IG © 2027+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#10.0.0-ballot based on FHIR 4.0.1. Generated 2026-10-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change