This page is part of the Structured Data Capture FHIR IG (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
This is a pre-release of a future version of SDC (expected to be STU 2). The current version is STU 2.
For a full list of available versions, see the Directory of published versions .
The official URL for this profile is:
http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-response
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from QuestionnaireResponse
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | |||
identifier | S | 0..1 | Identifier | |
basedOn | 0..* | Reference(DiagnosticRequest | ReferralRequest | CarePlan) | ||
parent | 0..* | Reference(Observation | Procedure) | ||
questionnaire | S | 1..1 | Reference(Profile sdc-questionnaire) | |
status | S | 1..1 | code | |
subject | S | 1..1 | Reference(Patient) | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | ||
author | S | 0..1 | Reference(Device | Practitioner | Patient | RelatedPerson) | |
authored | S | 1..1 | dateTime | |
source | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | ||
item | S | 0..* | BackboneElement | |
linkId | S | 1..1 | string | |
text | S | 0..1 | string | |
subject | 0..1 | Reference(Patient) | ||
answer | S | 0..* | BackboneElement | |
value[x] | S | 0..1 | boolean, date, dateTime, time, instant, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | |
item | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item | ||
item | S | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | I | 0..* | A structured set of questions and their answers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..1 | Identifier | Unique id for this set of answers |
basedOn | 0..* | Reference(DiagnosticRequest | ReferralRequest | CarePlan) | Request fulfilled by this Questionnaire | |
parent | 0..* | Reference(Observation | Procedure) | Part of this action | |
questionnaire | S | 1..1 | Reference(Profile sdc-questionnaire) | A structured set of questions |
status | ?!S | 1..1 | code | in-progress | completed | amended Binding: QuestionnaireResponseStatus (required) |
subject | S | 1..1 | Reference(Patient) | Information about an individual or animal receiving health care services |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed | |
author | S | 0..1 | Reference(Device | Practitioner | Patient | RelatedPerson) | Person who received and recorded the answers |
authored | S | 1..1 | dateTime | Date this version was authored |
source | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | The person who answered the questions | |
item | S | 0..* | BackboneElement | Groups and questions |
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 |
linkId | S | 1..1 | string | Corresponding item within Questionnaire |
text | S | 0..1 | string | Name for group or question text |
subject | 0..1 | Reference(Patient) | Information about an individual or animal receiving health care services | |
answer | S | 0..* | BackboneElement | The response(s) to the question |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | S | 0..1 | boolean, date, dateTime, time, instant, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | Single-valued answer to the question Binding: (unbound) (example) |
item | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item Nested groups and questions | ||
item | S | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item Nested questionnaire response items | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
yet to be done: Turtle template
This structure is derived from QuestionnaireResponse
Differential View
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | |||
identifier | S | 0..1 | Identifier | |
basedOn | 0..* | Reference(DiagnosticRequest | ReferralRequest | CarePlan) | ||
parent | 0..* | Reference(Observation | Procedure) | ||
questionnaire | S | 1..1 | Reference(Profile sdc-questionnaire) | |
status | S | 1..1 | code | |
subject | S | 1..1 | Reference(Patient) | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | ||
author | S | 0..1 | Reference(Device | Practitioner | Patient | RelatedPerson) | |
authored | S | 1..1 | dateTime | |
source | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | ||
item | S | 0..* | BackboneElement | |
linkId | S | 1..1 | string | |
text | S | 0..1 | string | |
subject | 0..1 | Reference(Patient) | ||
answer | S | 0..* | BackboneElement | |
value[x] | S | 0..1 | boolean, date, dateTime, time, instant, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | |
item | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item | ||
item | S | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | I | 0..* | A structured set of questions and their answers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..1 | Identifier | Unique id for this set of answers |
basedOn | 0..* | Reference(DiagnosticRequest | ReferralRequest | CarePlan) | Request fulfilled by this Questionnaire | |
parent | 0..* | Reference(Observation | Procedure) | Part of this action | |
questionnaire | S | 1..1 | Reference(Profile sdc-questionnaire) | A structured set of questions |
status | ?!S | 1..1 | code | in-progress | completed | amended Binding: QuestionnaireResponseStatus (required) |
subject | S | 1..1 | Reference(Patient) | Information about an individual or animal receiving health care services |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which questionnaire was completed | |
author | S | 0..1 | Reference(Device | Practitioner | Patient | RelatedPerson) | Person who received and recorded the answers |
authored | S | 1..1 | dateTime | Date this version was authored |
source | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | The person who answered the questions | |
item | S | 0..* | BackboneElement | Groups and questions |
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 |
linkId | S | 1..1 | string | Corresponding item within Questionnaire |
text | S | 0..1 | string | Name for group or question text |
subject | 0..1 | Reference(Patient) | Information about an individual or animal receiving health care services | |
answer | S | 0..* | BackboneElement | The response(s) to the question |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | S | 0..1 | boolean, date, dateTime, time, instant, decimal, integer, string, Coding, uri, Quantity, Attachment, Reference() | Single-valued answer to the question Binding: (unbound) (example) |
item | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item Nested groups and questions | ||
item | S | 0..* | Unknown reference to #QuestionnaireResponse:sdcdata.item Nested questionnaire response items | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
TTL Template
yet to be done: Turtle template
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
QuestionnaireResponse.language | Common Languages | extensible | Common Languages |
QuestionnaireResponse.status | QuestionnaireResponseStatus | required | QuestionnaireResponseStatus |
QuestionnaireResponse.item.answer.value[x] | ?ext | example |
Id | Path | Details | Requirements |
dom-2 | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | QuestionnaireResponse | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) |