Release 5 Preview #3
FoundationThis page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for questionnaireresponse
{
"resourceType" : "StructureDefinition",
"id" : "QuestionnaireResponse",
"meta" : {
"lastUpdated" : "2020-08-20T17:41:31.970+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"version" : "4.5.0",
"name" : "QuestionnaireResponse",
"status" : "draft",
"date" : "2020-08-20T17:41:31+10:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "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.",
"purpose" : "To support structured, hierarchical reporting of data gathered using digital forms and other questionnaires.",
"fhirVersion" : "4.5.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "QuestionnaireResponse",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "QuestionnaireResponse",
"path" : "QuestionnaireResponse",
"short" : "A structured set of questions and their answers",
"definition" : "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.",
"comment" : "The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.",
"alias" : ["Form",
"QuestionnaireAnswers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "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()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.id",
"path" : "QuestionnaireResponse.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.meta",
"path" : "QuestionnaireResponse.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.implicitRules",
"path" : "QuestionnaireResponse.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.language",
"path" : "QuestionnaireResponse.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "QuestionnaireResponse.text",
"path" : "QuestionnaireResponse.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "QuestionnaireResponse.contained",
"path" : "QuestionnaireResponse.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.extension",
"path" : "QuestionnaireResponse.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.modifierExtension",
"path" : "QuestionnaireResponse.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.identifier",
"path" : "QuestionnaireResponse.identifier",
"short" : "Unique id for this set of answers",
"definition" : "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements" : "Used for tracking, registration and other business purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "QuestionnaireResponse.basedOn",
"path" : "QuestionnaireResponse.basedOn",
"short" : "Request fulfilled by this QuestionnaireResponse",
"definition" : "The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.",
"requirements" : "Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.",
"alias" : ["order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "QuestionnaireResponse.partOf",
"path" : "QuestionnaireResponse.partOf",
"short" : "Part of this action",
"definition" : "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.",
"comment" : "Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.questionnaire",
"path" : "QuestionnaireResponse.questionnaire",
"short" : "Form being answered",
"definition" : "The Questionnaire that defines and organizes the questions for which answers are being provided.",
"comment" : "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.).",
"requirements" : "Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.",
"alias" : ["Form"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.questionnaire",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "QuestionnaireResponse.status",
"path" : "QuestionnaireResponse.status",
"short" : "in-progress | completed | amended | entered-in-error | stopped",
"definition" : "The position of the questionnaire response within its overall lifecycle.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireResponseStatus"
}],
"strength" : "required",
"description" : "Lifecycle status of the questionnaire response.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}]
},
{
"id" : "QuestionnaireResponse.subject",
"path" : "QuestionnaireResponse.subject",
"short" : "The subject of the questions",
"definition" : "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.",
"comment" : "If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.",
"requirements" : "Allows linking the answers to the individual the answers describe. May also affect access control.",
"alias" : ["Patient",
"Focus"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "QuestionnaireResponse.encounter",
"path" : "QuestionnaireResponse.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.",
"requirements" : "Provides context for the information that was captured. May also affect access control.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.authored",
"path" : "QuestionnaireResponse.authored",
"short" : "Date the answers were gathered",
"definition" : "The date and/or time that this set of answers were last changed.",
"comment" : "May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.\n\nThis element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.",
"requirements" : "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias" : ["Date Created",
"Date published",
"Date Issued",
"Date updated"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.authored",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "QuestionnaireResponse.author",
"path" : "QuestionnaireResponse.author",
"short" : "Person who received and recorded the answers",
"definition" : "Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.",
"comment" : "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.",
"requirements" : "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias" : ["Laboratory",
"Service",
"Practitioner",
"Department",
"Company",
"Performer"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "QuestionnaireResponse.source",
"path" : "QuestionnaireResponse.source",
"short" : "The person who answered the questions",
"definition" : "The person who answered the questions about the subject.",
"comment" : "If not specified, no inference can be made about who provided the data.",
"requirements" : "When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.source",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "QuestionnaireResponse.item",
"path" : "QuestionnaireResponse.item",
"short" : "Groups and questions",
"definition" : "A group or question item from the original questionnaire for which answers are provided.",
"comment" : "Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "qrs-1",
"severity" : "error",
"human" : "Nested item can't be beneath both item and answer",
"expression" : "(answer.exists() and item.exists()).not()",
"xpath" : "not(exists(f:answer) and exists(f:item))",
"source" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.id",
"path" : "QuestionnaireResponse.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.extension",
"path" : "QuestionnaireResponse.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.modifierExtension",
"path" : "QuestionnaireResponse.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.item.linkId",
"path" : "QuestionnaireResponse.item.linkId",
"short" : "Pointer to specific item from Questionnaire",
"definition" : "The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.",
"requirements" : "Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.linkId",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id"
}]
},
{
"id" : "QuestionnaireResponse.item.definition",
"path" : "QuestionnaireResponse.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.",
"comment" : "The ElementDefinition must be in a [StructureDefinition](structuredefinition.html#), and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].\n\nThere is no need for this element if the item pointed to by the linkId has a definition listed.",
"requirements" : "A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code"
}]
},
{
"id" : "QuestionnaireResponse.item.text",
"path" : "QuestionnaireResponse.item.text",
"short" : "Name for group or question text",
"definition" : "Text that is displayed above the contents of the group or as the text of the question being answered.",
"requirements" : "Allows the questionnaire response to be read without access to the questionnaire.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "QuestionnaireResponse.item.answer",
"path" : "QuestionnaireResponse.item.answer",
"short" : "The response(s) to the question",
"definition" : "The respondent's answer(s) to the question.",
"comment" : "The value is nested because we cannot have a repeating structure that has variable type.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.answer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".value[type=LIST_ANY]"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.id",
"path" : "QuestionnaireResponse.item.answer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.extension",
"path" : "QuestionnaireResponse.item.answer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.modifierExtension",
"path" : "QuestionnaireResponse.item.answer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.value[x]",
"path" : "QuestionnaireResponse.item.answer.value[x]",
"short" : "Single-valued answer to the question",
"definition" : "The answer (or one of the answers) provided by the respondent to the question.",
"comment" : "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.",
"requirements" : "Ability to retain a single-valued answer to a question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.answer.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireAnswer"
}],
"strength" : "example",
"description" : "Code indicating the response provided for a question.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : ".item"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.item",
"path" : "QuestionnaireResponse.item.answer.item",
"short" : "Nested groups and questions",
"definition" : "Nested groups and/or questions found within this particular answer.",
"requirements" : "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.answer.item",
"min" : 0,
"max" : "*"
},
"contentReference" : "#QuestionnaireResponse.item",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.item",
"path" : "QuestionnaireResponse.item.item",
"short" : "Nested questionnaire response items",
"definition" : "Questions or sub-groups nested beneath a question or group.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.item",
"min" : 0,
"max" : "*"
},
"contentReference" : "#QuestionnaireResponse.item",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "QuestionnaireResponse",
"path" : "QuestionnaireResponse",
"short" : "A structured set of questions and their answers",
"definition" : "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.",
"comment" : "The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.",
"alias" : ["Form",
"QuestionnaireAnswers"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.identifier",
"path" : "QuestionnaireResponse.identifier",
"short" : "Unique id for this set of answers",
"definition" : "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements" : "Used for tracking, registration and other business purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "QuestionnaireResponse.basedOn",
"path" : "QuestionnaireResponse.basedOn",
"short" : "Request fulfilled by this QuestionnaireResponse",
"definition" : "The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.",
"requirements" : "Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.",
"alias" : ["order"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "QuestionnaireResponse.partOf",
"path" : "QuestionnaireResponse.partOf",
"short" : "Part of this action",
"definition" : "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.",
"comment" : "Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.questionnaire",
"path" : "QuestionnaireResponse.questionnaire",
"short" : "Form being answered",
"definition" : "The Questionnaire that defines and organizes the questions for which answers are being provided.",
"comment" : "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.).",
"requirements" : "Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.",
"alias" : ["Form"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "QuestionnaireResponse.status",
"path" : "QuestionnaireResponse.status",
"short" : "in-progress | completed | amended | entered-in-error | stopped",
"definition" : "The position of the questionnaire response within its overall lifecycle.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireResponseStatus"
}],
"strength" : "required",
"description" : "Lifecycle status of the questionnaire response.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}]
},
{
"id" : "QuestionnaireResponse.subject",
"path" : "QuestionnaireResponse.subject",
"short" : "The subject of the questions",
"definition" : "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.",
"comment" : "If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.",
"requirements" : "Allows linking the answers to the individual the answers describe. May also affect access control.",
"alias" : ["Patient",
"Focus"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "QuestionnaireResponse.encounter",
"path" : "QuestionnaireResponse.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.",
"requirements" : "Provides context for the information that was captured. May also affect access control.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.authored",
"path" : "QuestionnaireResponse.authored",
"short" : "Date the answers were gathered",
"definition" : "The date and/or time that this set of answers were last changed.",
"comment" : "May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.\n\nThis element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.",
"requirements" : "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias" : ["Date Created",
"Date published",
"Date Issued",
"Date updated"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "QuestionnaireResponse.author",
"path" : "QuestionnaireResponse.author",
"short" : "Person who received and recorded the answers",
"definition" : "Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.",
"comment" : "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.",
"requirements" : "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias" : ["Laboratory",
"Service",
"Practitioner",
"Department",
"Company",
"Performer"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "QuestionnaireResponse.source",
"path" : "QuestionnaireResponse.source",
"short" : "The person who answered the questions",
"definition" : "The person who answered the questions about the subject.",
"comment" : "If not specified, no inference can be made about who provided the data.",
"requirements" : "When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "QuestionnaireResponse.item",
"path" : "QuestionnaireResponse.item",
"short" : "Groups and questions",
"definition" : "A group or question item from the original questionnaire for which answers are provided.",
"comment" : "Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "qrs-1",
"severity" : "error",
"human" : "Nested item can't be beneath both item and answer",
"expression" : "(answer.exists() and item.exists()).not()",
"xpath" : "not(exists(f:answer) and exists(f:item))",
"source" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.linkId",
"path" : "QuestionnaireResponse.item.linkId",
"short" : "Pointer to specific item from Questionnaire",
"definition" : "The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.",
"requirements" : "Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id"
}]
},
{
"id" : "QuestionnaireResponse.item.definition",
"path" : "QuestionnaireResponse.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.",
"comment" : "The ElementDefinition must be in a [StructureDefinition](structuredefinition.html#), and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].\n\nThere is no need for this element if the item pointed to by the linkId has a definition listed.",
"requirements" : "A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code"
}]
},
{
"id" : "QuestionnaireResponse.item.text",
"path" : "QuestionnaireResponse.item.text",
"short" : "Name for group or question text",
"definition" : "Text that is displayed above the contents of the group or as the text of the question being answered.",
"requirements" : "Allows the questionnaire response to be read without access to the questionnaire.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "QuestionnaireResponse.item.answer",
"path" : "QuestionnaireResponse.item.answer",
"short" : "The response(s) to the question",
"definition" : "The respondent's answer(s) to the question.",
"comment" : "The value is nested because we cannot have a repeating structure that has variable type.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".value[type=LIST_ANY]"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.value[x]",
"path" : "QuestionnaireResponse.item.answer.value[x]",
"short" : "Single-valued answer to the question",
"definition" : "The answer (or one of the answers) provided by the respondent to the question.",
"comment" : "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.",
"requirements" : "Ability to retain a single-valued answer to a question.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireAnswer"
}],
"strength" : "example",
"description" : "Code indicating the response provided for a question.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : ".item"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.item",
"path" : "QuestionnaireResponse.item.answer.item",
"short" : "Nested groups and questions",
"definition" : "Nested groups and/or questions found within this particular answer.",
"requirements" : "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min" : 0,
"max" : "*",
"contentReference" : "#QuestionnaireResponse.item",
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.item",
"path" : "QuestionnaireResponse.item.item",
"short" : "Nested questionnaire response items",
"definition" : "Questions or sub-groups nested beneath a question or group.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"contentReference" : "#QuestionnaireResponse.item",
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:46+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change