This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Profile for questionnaireanswers
{ "resourceType": "Profile", "id": "QuestionnaireAnswers", "meta": { "lastUpdated": "2015-02-23T09:07:27.665+11:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/Profile/QuestionnaireAnswers", "name": "QuestionnaireAnswers", "publisher": "HL7 FHIR Project (Patient Care)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/patientcare/index.cfm" } ] } ], "description": "Base Profile for QuestionnaireAnswers Resource", "status": "draft", "date": "2015-02-23T09:07:27+11:00", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" } ], "type": "QuestionnaireAnswers", "snapshot": { "element": [ { "path": "QuestionnaireAnswers", "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 underlying questions.", "requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.", "synonym": [ "Form" ], "min": 1, "max": "1", "mapping": [ { "identity": "rim", "map": "Observation[moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.id", "short": "Logical id of this artefact", "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "type": [ { "code": "id" } ] }, { "path": "QuestionnaireAnswers.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", "type": [ { "code": "Meta" } ] }, { "path": "QuestionnaireAnswers.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.", "comments": "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 as much as possible.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true }, { "path": "QuestionnaireAnswers.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "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\n\nNot 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", "type": [ { "code": "code" } ], "binding": { "name": "Language", "isExtensible": false, "conformance": "required", "description": "A human language", "referenceUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "QuestionnaireAnswers.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.", "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "synonym": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "QuestionnaireAnswers.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, and nor can they have their own independent transaction scope.", "comments": "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.", "synonym": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.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. 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.", "comments": "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.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.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.", "comments": "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.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.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": "rim", "map": ".id" } ] }, { "path": "QuestionnaireAnswers.questionnaire", "short": "Form being answered", "definition": "Indicates the Questionnaire resource that defines the form for which answers are being provided.", "requirements": "Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form.", "synonym": [ "Form" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Questionnaire" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.status", "short": "in-progress | completed | amended", "definition": "The lifecycle status of the questionnaire answers as a whole.", "requirements": "The information on questionnaires may possibly be gathered during multiple sessions and altered after considered being finished. Questionnaires with just questions may serve as template forms, with the applicable publication statuses.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "name": "QuestionnaireAnswersStatus", "isExtensible": false, "conformance": "required", "description": "Lifecycle status of the questionnaire answers", "referenceReference": { "reference": "http://hl7.org/fhir/vs/questionnaire-answers-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)" } ] }, { "path": "QuestionnaireAnswers.subject", "short": "The subject of the questions", "definition": "The subject of the questionnaire answers. 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.", "requirements": "Must know the subject context.", "synonym": [ "Patient", "Focus" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "path": "QuestionnaireAnswers.author", "short": "Person who received and recorded the answers", "definition": "Person who received the answers to the questions in the QuestionnaireAnswers and recorded them in the system.", "comments": "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.", "requirements": "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.", "synonym": [ "Laboratory", "Service", "Practitioner", "Department", "Company" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "path": "QuestionnaireAnswers.authored", "short": "Date this version was authored", "definition": "The date and/or time that this version of the questionnaire answers was authored.", "comments": "May be different from the update time of the resource itself, because that is the status of the collection and authoring.", "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.", "synonym": [ "Date Created", "Date published", "Date Issued", "Date updated" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ] }, { "path": "QuestionnaireAnswers.source", "short": "The person who answered the questions", "definition": "The person who answered the questions about the subject.", "comments": "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 is used to answer the questions.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=INF].role" } ] }, { "path": "QuestionnaireAnswers.encounter", "short": "Primary encounter during which the answers were collected", "definition": "Encounter during which this set of questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.", "requirements": "Some institutions track questionnaires under a specific encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Encounter" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group", "name": "group", "short": "Grouped questions", "definition": "A group of questions to a possibly similarly grouped set of questions in the questionnaire answers.", "comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.", "requirements": "Need to be able to logically group answers to grouped questions.", "min": 0, "max": "1", "constraint": [ { "key": "qan-1", "name": "GroupHaveSubOrQuestions", "severity": "error", "human": "Groups may either contain questions or groups but not both", "xpath": "not(exists(f:group) and exists(f:question))" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.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.", "comments": "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.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.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.", "comments": "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.", "synonym": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.group.linkId", "short": "Corresponding group within Questionnaire", "definition": "Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireAnswers resource.", "requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.group.title", "short": "Name for this group", "definition": "Text that is displayed above the contents of the group.", "comments": "On the root group, this is the title of the questionnaire.", "requirements": "When including text for the questionnaire with the answers, sections may have a section header.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".title" } ] }, { "path": "QuestionnaireAnswers.group.text", "short": "Additional text for the group", "definition": "Additional text for the group, used for display purposes.", "requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] }, { "path": "QuestionnaireAnswers.group.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 QuestionnaireAnswers.", "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", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role\nor\n.outboundRelationship[typeCode=SUBJ].target" } ] }, { "path": "QuestionnaireAnswers.group.group", "short": "Nested questionnaire answers group", "definition": "A sub-group within a group. The ordering of groups within this group is relevant.", "requirements": "Reports can consist of complex nested groups.", "min": 0, "max": "*", "nameReference": "group", "condition": [ "qan-1" ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group.question", "short": "Questions in this group", "definition": "Set of questions within this group. The order of questions within the group is relevant.", "requirements": "Must register answers to questions.", "synonym": [ "Responses", "Contents" ], "min": 0, "max": "*", "condition": [ "qan-1" ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]" } ] }, { "path": "QuestionnaireAnswers.group.question.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.question.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.", "comments": "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.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.question.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.", "comments": "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.", "synonym": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.group.question.linkId", "short": "Corresponding question within Questionnaire", "definition": "Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireAnswers resource.", "requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.group.question.text", "short": "Text of the question as it is shown to the user", "definition": "The actual question as shown to the user to prompt them for an answer.", "requirements": "When including text for the questionnaire, each question may contain its actual question display text.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".code.display" } ] }, { "path": "QuestionnaireAnswers.group.question.answer", "short": "The response(s) to the question", "definition": "The respondent's answer(s) to the question.", "comments": "We nest the value because we can't have a repeating structure that has variable type.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": ".value[type=LIST_ANY]" } ] }, { "path": "QuestionnaireAnswers.group.question.answer.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.question.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.", "comments": "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.", "synonym": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "QuestionnaireAnswers.group.question.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.", "comments": "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.", "synonym": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "QuestionnaireAnswers.group.question.answer.value[x]", "short": "Single-valued answer to the question", "definition": "The answer (or one of the answers) provided by the respondant to the question.", "comments": "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": "Need to be able 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": "instant" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "mapping": [ { "identity": "rim", "map": ".item" } ] }, { "path": "QuestionnaireAnswers.group.question.group", "short": "Nested questionnaire group", "definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.", "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": "*", "nameReference": "group", "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]" } ] } ] }, "differential": { "element": [ { "path": "QuestionnaireAnswers", "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 underlying questions.", "requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.", "synonym": [ "Form" ], "min": 1, "max": "1", "mapping": [ { "identity": "rim", "map": "Observation[moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.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": "rim", "map": ".id" } ] }, { "path": "QuestionnaireAnswers.questionnaire", "short": "Form being answered", "definition": "Indicates the Questionnaire resource that defines the form for which answers are being provided.", "requirements": "Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form.", "synonym": [ "Form" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Questionnaire" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.status", "short": "in-progress | completed | amended", "definition": "The lifecycle status of the questionnaire answers as a whole.", "requirements": "The information on questionnaires may possibly be gathered during multiple sessions and altered after considered being finished. Questionnaires with just questions may serve as template forms, with the applicable publication statuses.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "name": "QuestionnaireAnswersStatus", "isExtensible": false, "conformance": "required", "description": "Lifecycle status of the questionnaire answers", "referenceReference": { "reference": "http://hl7.org/fhir/vs/questionnaire-answers-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)" } ] }, { "path": "QuestionnaireAnswers.subject", "short": "The subject of the questions", "definition": "The subject of the questionnaire answers. 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.", "requirements": "Must know the subject context.", "synonym": [ "Patient", "Focus" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "path": "QuestionnaireAnswers.author", "short": "Person who received and recorded the answers", "definition": "Person who received the answers to the questions in the QuestionnaireAnswers and recorded them in the system.", "comments": "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.", "requirements": "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.", "synonym": [ "Laboratory", "Service", "Practitioner", "Department", "Company" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "path": "QuestionnaireAnswers.authored", "short": "Date this version was authored", "definition": "The date and/or time that this version of the questionnaire answers was authored.", "comments": "May be different from the update time of the resource itself, because that is the status of the collection and authoring.", "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.", "synonym": [ "Date Created", "Date published", "Date Issued", "Date updated" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ] }, { "path": "QuestionnaireAnswers.source", "short": "The person who answered the questions", "definition": "The person who answered the questions about the subject.", "comments": "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 is used to answer the questions.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=INF].role" } ] }, { "path": "QuestionnaireAnswers.encounter", "short": "Primary encounter during which the answers were collected", "definition": "Encounter during which this set of questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.", "requirements": "Some institutions track questionnaires under a specific encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Encounter" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group", "name": "group", "short": "Grouped questions", "definition": "A group of questions to a possibly similarly grouped set of questions in the questionnaire answers.", "comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.", "requirements": "Need to be able to logically group answers to grouped questions.", "min": 0, "max": "1", "constraint": [ { "key": "qan-1", "name": "GroupHaveSubOrQuestions", "severity": "error", "human": "Groups may either contain questions or groups but not both", "xpath": "not(exists(f:group) and exists(f:question))" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group.linkId", "short": "Corresponding group within Questionnaire", "definition": "Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireAnswers resource.", "requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.group.title", "short": "Name for this group", "definition": "Text that is displayed above the contents of the group.", "comments": "On the root group, this is the title of the questionnaire.", "requirements": "When including text for the questionnaire with the answers, sections may have a section header.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".title" } ] }, { "path": "QuestionnaireAnswers.group.text", "short": "Additional text for the group", "definition": "Additional text for the group, used for display purposes.", "requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] }, { "path": "QuestionnaireAnswers.group.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 QuestionnaireAnswers.", "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", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role\nor\n.outboundRelationship[typeCode=SUBJ].target" } ] }, { "path": "QuestionnaireAnswers.group.group", "short": "Nested questionnaire answers group", "definition": "A sub-group within a group. The ordering of groups within this group is relevant.", "requirements": "Reports can consist of complex nested groups.", "min": 0, "max": "*", "nameReference": "group", "condition": [ "qan-1" ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]" } ] }, { "path": "QuestionnaireAnswers.group.question", "short": "Questions in this group", "definition": "Set of questions within this group. The order of questions within the group is relevant.", "requirements": "Must register answers to questions.", "synonym": [ "Responses", "Contents" ], "min": 0, "max": "*", "condition": [ "qan-1" ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]" } ] }, { "path": "QuestionnaireAnswers.group.question.linkId", "short": "Corresponding question within Questionnaire", "definition": "Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireAnswers resource.", "requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]" } ] }, { "path": "QuestionnaireAnswers.group.question.text", "short": "Text of the question as it is shown to the user", "definition": "The actual question as shown to the user to prompt them for an answer.", "requirements": "When including text for the questionnaire, each question may contain its actual question display text.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": ".code.display" } ] }, { "path": "QuestionnaireAnswers.group.question.answer", "short": "The response(s) to the question", "definition": "The respondent's answer(s) to the question.", "comments": "We nest the value because we can't have a repeating structure that has variable type.", "min": 0, "max": "*", "mapping": [ { "identity": "rim", "map": ".value[type=LIST_ANY]" } ] }, { "path": "QuestionnaireAnswers.group.question.answer.value[x]", "short": "Single-valued answer to the question", "definition": "The answer (or one of the answers) provided by the respondant to the question.", "comments": "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": "Need to be able 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": "instant" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "profile": "http://hl7.org/fhir/Profile/Any" } ], "mapping": [ { "identity": "rim", "map": ".item" } ] }, { "path": "QuestionnaireAnswers.group.question.group", "short": "Nested questionnaire group", "definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.", "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": "*", "nameReference": "group", "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, 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.