This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions 
JSON Format: StructureDefinition-argo-adap-questionnaireresponse
Download Raw json
{
"resourceType" : "StructureDefinition",
"id" : "argo-adap-questionnaireresponse",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-argo-adap-questionnaireresponse-definitions.html#QuestionnaireResponse\">QuestionnaireResponse</a><a name=\"QuestionnaireResponse\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-argo-adap-questionnaireresponse-definitions.html#QuestionnaireResponse.contained\">contained</a><a name=\"QuestionnaireResponse.contained\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-argo-questionnaire.html\" title=\"Questionnaire\">argo_questionnaire</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/STU3/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/STU3/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse",
"version" : "1.0.0",
"name" : "argo_adap_questionnaireresponse",
"title" : "Argonaut Adaptive QuestionnaireResponse Profile",
"status" : "active",
"experimental" : false,
"date" : "2019-02-16T00:00:00+11:00",
"description" : "The Argonaut Adaptive QuestionnaireResponse Profile supports the [adaptive questionnaire use case](adaptive.html) and is derived from the [Argonaut QuestionnaireResponse profile](StructureDefinition-argo-questionnaireresponse.html). This profile defines the structure that is passed between the Client and Server using the [`$next-question`](OperationDefinition-next-question.html) operation and records the question-answer pairs and questionnaire questions from the adaptive questionnaire.\n\n **Mandatory Data Element:**\n - A [*contained*](http://hl7.org/fhir/STU3/references.html#contained) [Argonaut Questionnaire Profile](StructureDefinition-argo-questionnaire.html)",
"fhirVersion" : "3.0.1",
"mapping" : [
{
"identity" : "r4",
"uri" : "http://unknown.org/R4",
"name" : "R4"
},
{
"identity" : "r2",
"uri" : "http://unknown.org/R2",
"name" : "R2"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "QuestionnaireResponse",
"baseDefinition" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaireresponse",
"derivation" : "constraint",
"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" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "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" : "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",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
}
],
"mustSupport" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=EVN]"
},
{
"identity" : "w5",
"map" : "infrastructure.information"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse"
}
]
},
{
"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" : [
{
"code" : "id"
}
],
"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 may 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"
}
],
"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.",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"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"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "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" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "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 may 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 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 in formation is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "QuestionnaireResponse.contained",
"path" : "QuestionnaireResponse.contained",
"short" : "A structured set of questions",
"definition" : "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"comment" : "Since an adaptative questionnnaire is unique for each session, the Server builds a unique questionnaire instance \"on the fly\" as each question is asked.",
"requirements" : "The responses to an adaptive questionnaire need the questionnaires context to be fully understood.",
"alias" : [
"Form",
"CRF",
"Survey"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Questionnaire",
"profile" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire"
}
],
"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" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "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" : "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",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
},
{
"key" : "que-2",
"severity" : "error",
"human" : "The link ids for groups and questions must be unique within the questionnaire",
"expression" : "descendants().linkId.isDistinct()",
"xpath" : "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))",
"source" : "Questionnaire"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=DEF]"
},
{
"identity" : "w5",
"map" : "infrastructure.information"
},
{
"identity" : "r4",
"map" : "Questionnaire"
},
{
"identity" : "r2",
"map" : "Questionnaire"
}
]
},
{
"id" : "QuestionnaireResponse.extension",
"path" : "QuestionnaireResponse.extension",
"slicing" : {
"id" : "1",
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"ordered" : false,
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "QuestionnaireResponse.extension:q-response-period",
"path" : "QuestionnaireResponse.extension",
"sliceName" : "q-response-period",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"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. Usually modifier elements provide negation or qualification. In order 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.",
"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.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"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"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "w5",
"map" : "id"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.identifier"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.identifier"
}
]
},
{
"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 ProcedureRequest 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/ReferralRequest"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"id" : "QuestionnaireResponse.parent",
"path" : "QuestionnaireResponse.parent",
"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.parent",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary" : true,
"mapping" : [
{
"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" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.questionnaire",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.questionnaire"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.questionnaire"
}
]
},
{
"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"
}
],
"mustSupport" : true,
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireResponseStatus"
}
],
"strength" : "required",
"description" : "Lifecycle status of the questionnaire response.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/questionnaire-answers-status"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
},
{
"identity" : "w5",
"map" : "status"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.status"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.status"
}
]
},
{
"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" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "who.focus"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.subject"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.subject"
}
]
},
{
"id" : "QuestionnaireResponse.context",
"path" : "QuestionnaireResponse.context",
"short" : "Encounter or Episode during which questionnaire was completed",
"definition" : "The encounter or episode of care with primary association to the questionnaire response.",
"comment" : "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.context",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
},
{
"identity" : "w5",
"map" : "context"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.subject"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.subject"
}
]
},
{
"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 may 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" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.authored",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
},
{
"identity" : "w5",
"map" : "when.recorded"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.authored"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.authored"
}
]
},
{
"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/us/core/StructureDefinition/us-core-practitioner"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
},
{
"identity" : "w5",
"map" : "who.author"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.author"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.author"
}
]
},
{
"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/us/core/StructureDefinition/us-core-practitioner"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
},
{
"identity" : "w5",
"map" : "who.source"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.source"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.source"
}
]
},
{
"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() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "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" : "QuestionnaireResponse.item"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group"
}
]
},
{
"id" : "QuestionnaireResponse.item.id",
"path" : "QuestionnaireResponse.item.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"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" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "QuestionnaireResponse.item.extension",
"path" : "QuestionnaireResponse.item.extension",
"slicing" : {
"id" : "2",
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"ordered" : false,
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "QuestionnaireResponse.item.extension:item-response-period",
"path" : "QuestionnaireResponse.item.extension",
"sliceName" : "item-response-period",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-responsePeriod"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"id" : "QuestionnaireResponse.item.modifierExtension",
"path" : "QuestionnaireResponse.item.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"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 may not exist - requiring correspondence by identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.linkId",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.linkId"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.linkId, QuestionnaireResponse.group.question.linkId"
}
]
},
{
"id" : "QuestionnaireResponse.item.definition",
"path" : "QuestionnaireResponse.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "A reference to an [ElementDefinition](http://hl7.org/fhir/STU3/elementdefinition.html) that provides the details for the item.",
"comment" : "The ElementDefinition must be in a [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html) or a [DataElement](http://hl7.org/fhir/STU3/dataelement.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"
}
],
"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"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.text"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.text. QuestionnaireResponse.group.question.text (QuestionnaireResponse.group.title (removed element in R3))"
}
]
},
{
"id" : "QuestionnaireResponse.item.subject",
"path" : "QuestionnaireResponse.item.subject",
"short" : "The subject this group's answers are about",
"definition" : "More specific subject this section's answers are about, details the subject given in QuestionnaireResponse.",
"requirements" : "Sometimes a group of answers is about a specific participant, artifact or piece of information in the patient's care or record, e.g. a specific Problem, RelatedPerson, Allergy etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role or .outboundRelationship[typeCode=SUBJ].target"
}
]
},
{
"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() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".value[type=LIST_ANY]"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.answer"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.question.answer"
}
]
},
{
"id" : "QuestionnaireResponse.item.answer.id",
"path" : "QuestionnaireResponse.item.answer.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"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" : [
{
"code" : "string"
}
],
"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. In order 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.",
"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"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "QuestionnaireResponse.item.answer.modifierExtension",
"path" : "QuestionnaireResponse.item.answer.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"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.",
"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" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
}
],
"mustSupport" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireAnswer"
}
],
"strength" : "example",
"description" : "Code indicating the response provided for a question.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".item"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.answer.value[x]"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.question.answer.value[x]"
}
]
},
{
"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",
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.answer.item"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.question.answer.group"
}
]
},
{
"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",
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "r4",
"map" : "QuestionnaireResponse.item.item"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse.group.question, QuestionnaireResponse.group.group"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "QuestionnaireResponse",
"path" : "QuestionnaireResponse",
"mustSupport" : false,
"isModifier" : false,
"mapping" : [
{
"identity" : "r4",
"map" : "QuestionnaireResponse"
},
{
"identity" : "r2",
"map" : "QuestionnaireResponse"
}
]
},
{
"id" : "QuestionnaireResponse.contained",
"path" : "QuestionnaireResponse.contained",
"comment" : "Since an adaptative questionnnaire is unique for each session, the Server builds a unique questionnaire instance \"on the fly\" as each question is asked.",
"requirements" : "The responses to an adaptive questionnaire need the questionnaires context to be fully understood.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Questionnaire",
"profile" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire"
}
],
"mustSupport" : true,
"isModifier" : false
}
]
}
}
