Structured Data Capture 2.5.0 - Edition 3(STU), For Comment 2018Sep Ballot
This page is part of the Structured Data Capture FHIR IG (v2.5.0: STU 3 Ballot 1) based on FHIR v3.5.0. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse
This profile sets expectations for use of the QuestionnaireResponse resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.
For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the QuestionnaireResponse resource. It means that servers SHALL be capable of persisting those elements and returning them in response to requests.
This profile is related to the SDC Questionnaire Profile which defines the characteristic of a form "design". This profile focuses on the constraints appropriate to capturing the "answer(s)" to a pre-defined form.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from QuestionnaireResponse
Summary
Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from QuestionnaireResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  QuestionnaireResponse | I | 0..* | SDC Questionnaire Response | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| questionnaireresponse-signature | I | 0..* | Signature | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 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 | SΣ | 1..1 | canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire) | Form being answered |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| display | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/display |
 value | 0..1 | Primitive value for canonical | ||
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required) |
| subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 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 | SI | 0..* | BackboneElement | Groups and questions |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| questionnaireresponse-signature | I | 0..* | Signature | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| text | S | 0..1 | string | Name for group or question text |
| answer | SI | 0..* | BackboneElement | The response(s) to the question |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
 value[x] | S | 0..1 | boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example) |
| item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested groups and questions | |
| item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested questionnaire response items | |
| Documentation for this format | ||||
This structure is derived from QuestionnaireResponse
Summary
Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from QuestionnaireResponse
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| QuestionnaireResponse | I | 0..* | SDC Questionnaire Response | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| questionnaireresponse-signature | I | 0..* | Signature | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 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 | SΣ | 1..1 | canonical(http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire) | Form being answered |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| display | SI | 1..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/display |
| value | 0..1 | Primitive value for canonical | ||
| status | ?!SΣ | 1..1 | code | in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required) |
| subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed |
| authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
| author | SΣ | 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 | SI | 0..* | BackboneElement | Groups and questions |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| questionnaireresponse-signature | I | 0..* | Signature | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
| linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| text | S | 0..1 | string | Name for group or question text |
| answer | SI | 0..* | BackboneElement | The response(s) to the question |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
| value[x] | S | 0..1 | boolean, date, dateTime, time, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example) |
| item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested groups and questions | |
| item | S | 0..* | Unknown reference to #QuestionnaireResponse.item Nested questionnaire response items | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| QuestionnaireResponse.language | Language | preferred | Common Languages |
| QuestionnaireResponse.status | QuestionnaireResponseStatus | required | QuestionnaireResponseStatus |
| QuestionnaireResponse.item.answer.value[x] | Questionnaire Answer Codes | example | QuestionnaireAnswerCodes |
| Id | Path | Details | Requirements |
| dom-2 | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | QuestionnaireResponse | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-6 | QuestionnaireResponse | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| ele-1 | QuestionnaireResponse.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.questionnaire.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.questionnaire.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.questionnaire.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.questionnaire.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| qrs-1 | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() | |
| ele-1 | QuestionnaireResponse.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | QuestionnaireResponse.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | QuestionnaireResponse.item.answer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© 2015+ HL7 International (OO work group). Based on FHIR version (3.5.0-14923). IG generated on Fri, Aug 31, 2018 16:04+1000.
Links: Version History |
Table of Contents |
|
Propose a change