2nd DSTU Draft For Comment

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 Structured Data Capture Data Capture - Definitions

Todo

Definitions for the questionnaireanswers-sdc-structureddatacaptureanswers Profile.

QuestionnaireAnswers(StructuredDataCaptureAnswers)
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.

Control1..1
Requirements

To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.

Alternate NamesForm, Form Data
Comments
QuestionnaireAnswers.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
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.

QuestionnaireAnswers.meta
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.

Control0..1
TypeMeta
Requirements
Comments
QuestionnaireAnswers.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
Requirements
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.

QuestionnaireAnswers.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
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

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).

QuestionnaireAnswers.text
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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

QuestionnaireAnswers.contained
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.

Control0..*
TypeResource
Requirements
Alternate Namesinline resources, anonymous resources, contained resources
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.

QuestionnaireAnswers.extension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
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.

QuestionnaireAnswers.modifierExtension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
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.

QuestionnaireAnswers.identifier
Definition

A business identifier assigned to a particular completed (or partially completed) questionnaire.

Control0..1
TypeIdentifier
Must Supporttrue
Requirements

Used for tracking, registration and other business purposes.

Comments
QuestionnaireAnswers.questionnaire
Definition

Indicates the Questionnaire resource that defines the form for which answers are being provided.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Questionnaire))
Must Supporttrue
Requirements

Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form.

Alternate NamesForm
Comments
QuestionnaireAnswers.status
Definition

The lifecycle status of the questionnaire answers as a whole.

Control1..1
BindingLifecycle status of the questionnaire answers
The codes SHALL be taken from QuestionnaireAnswersStatus
Typecode
Is Modifiertrue
Must Supporttrue
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.

Comments
QuestionnaireAnswers.subject
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.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Must Supporttrue
Requirements

Must know the subject context.

Alternate NamesPatient, Focus
Comments
QuestionnaireAnswers.author
Definition

Person who received the answers to the questions in the QuestionnaireAnswers and recorded them in the system.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson))
Must Supporttrue
Requirements

Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.

Alternate NamesLaboratory, Service, Practitioner, Department, Company
Comments

Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.

QuestionnaireAnswers.authored
Definition

Identifies when this version of the answer set was created. Changes whenever the answers are updated.

Control1..1
TypedateTime
Must Supporttrue
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.

Alternate NamesDate Created, Date published, Date Issued, Date updated
Comments

May be different from the update time of the resource itself, because that is the status of the collection and authoring.

QuestionnaireAnswers.source
Definition

The person who answered the questions about the subject.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson))
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.

Comments

If not specified, no inference can be made about who provided the data.

QuestionnaireAnswers.encounter
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.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Encounter))
Requirements

Some institutions track questionnaires under a specific encounter.

Comments
QuestionnaireAnswers.group(group)
Definition

A group of questions to a possibly similarly grouped set of questions in the questionnaire answers.

Control1..1
Must Supporttrue
Requirements

Need to be able to logically group answers to grouped questions.

Comments

The Questionnaire itself has one "root" group with the actual contents of the Questionnaire.

InvariantsDefined on this element
qan-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question)))
QuestionnaireAnswers.group.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
QuestionnaireAnswers.group.extension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
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.

QuestionnaireAnswers.group.modifierExtension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
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.

QuestionnaireAnswers.group.linkId
Definition

Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireAnswers resource.

Control1..1
Typestring
Must Supporttrue
Requirements

Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.

Comments
QuestionnaireAnswers.group.title
Definition

Text that is displayed above the contents of the group.

Control0..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire with the answers, sections may have a section header.

Comments

On the root group, this is the title of the questionnaire.

QuestionnaireAnswers.group.text
Definition

Additional text for the group, used for display purposes.

Control0..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire, each section may contain additional explanations are background text.

Comments
QuestionnaireAnswers.group.subject
Definition

More specific subject this section's answers are about, details the subject given in QuestionnaireAnswers.

Control0..1
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
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.

Comments
QuestionnaireAnswers.group.group
Definition

A sub-group within a group. The ordering of groups within this group is relevant.

Control0..* This element is affected by the following invariants: qan-1
TypeSee group
Must Supporttrue
Requirements

Reports can consist of complex nested groups.

Comments
QuestionnaireAnswers.group.question
Definition

Set of questions within this group. The order of questions within the group is relevant.

Control0..* This element is affected by the following invariants: qan-1
Must Supporttrue
Requirements

Must register answers to questions.

Alternate NamesResponses, Contents
Comments
QuestionnaireAnswers.group.question.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
QuestionnaireAnswers.group.question.extension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
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.

QuestionnaireAnswers.group.question.modifierExtension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
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.

QuestionnaireAnswers.group.question.linkId
Definition

Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireAnswers resource.

Control1..1
Typestring
Must Supporttrue
Requirements

Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.

Comments
QuestionnaireAnswers.group.question.text
Definition

The actual question as shown to the user to prompt them for an answer.

Control1..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire, each question may contain its actual question display text.

Comments
QuestionnaireAnswers.group.question.answer
Definition

The respondent's answer(s) to the question.

Control0..*
Must Supporttrue
Requirements
Comments

We nest the value because we can't have a repeating structure that has variable type.

QuestionnaireAnswers.group.question.answer.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
QuestionnaireAnswers.group.question.answer.extension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
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.

QuestionnaireAnswers.group.question.answer.modifierExtension
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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
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.

QuestionnaireAnswers.group.question.answer.value[x]
Definition

The answer (or one of the answers) provided by the respondant to the question.

Control0..*
TypeChoice of: boolean, date, dateTime, time, instant, decimal, integer, string, Coding, Attachment, Reference(Profile = http://hl7.org/fhir/Profile/Any)
Must Supporttrue
Requirements

Need to be able to retain a single-valued answer to a 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.

QuestionnaireAnswers.group.question.group
Definition

Nested group, containing nested question for this question. The order of groups within the question is relevant.

Control0..*
TypeSee group
Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.

Comments