Tervisedeklaratsiooni juurutusjuhend
1.0.0 - ci-build

Tervisedeklaratsiooni juurutusjuhend, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-hdecl/ and changes regularly. See the Directory of published versions

Resource Profile: EEHealthDeclaration - Detailed Descriptions

Draft as of 2024-01-01

Definitions for the ee-health-declaration resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. QuestionnaireResponse
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.

ShortA structured set of questions and their answers
Comments

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.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesForm, QuestionnaireAnswers
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. QuestionnaireResponse.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. QuestionnaireResponse.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control10..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. QuestionnaireResponse.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..0*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. QuestionnaireResponse.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on QuestionnaireResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. QuestionnaireResponse.extension:categories
    Slice Namecategories
    Definition

    Tervise deklaratsiooni kasutusala ja selle kehtivuse periood

    ShortTervise deklaratsiooni kasutusala
    Control1..*
    TypeExtension(Tervise deklaratsiooni kasutusala) (Complex Extension)
    Is Modifierfalse
    Must Supportfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. QuestionnaireResponse.modifierExtension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensionExtensions that cannot be ignored
    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.

    Control0..0*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. QuestionnaireResponse.basedOn
    Definition

    A plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

    ShortRequest fulfilled by this QuestionnaireResponse
    Control0..0*
    TypeReference(CarePlan, ServiceRequest)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Supports traceability of responsibility for the questionnaire response and allows linkage of the response to the proposals/recommendations acted upon.

    Alternate Namesorder
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. QuestionnaireResponse.partOf
    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.

    ShortPart of referenced event
    Comments

    Not to be used to link an questionnaire response to an Encounter - use 'context' for that.

    Composition of questionnaire responses will be handled using the Assemble operation defined in the SDC IG. For relationships to referrals, and other types of requests, use basedOn.

    Control0..0*
    TypeReference(Observation, Procedure)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. QuestionnaireResponse.questionnaire
    Definition

    The Questionnaire that defines and organizes the questions for which answers are being provided.

    ShortCanonical URL of Questionnaire being answered
    Comments

    If a QuestionnaireResponse references a Questionnaire that can be resolved, 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.). It is possible to have a QuestionnaireResponse whose 'questionnaire' element does not resolve. It is also possible for the questionnaire element to not have a value but only extensions (e.g. conveying the title or identifier for the questionnaire). This may happen for legacy data. If there is no formally defined Questionnaire, it is undefined what the 'correct' values for the linkId elements should be and it is possible that linkIds might be inconsistent for QuestionnaireResponses for the same form if captured by distinct systems.

    Control1..1
    Typecanonical(Questionnaire)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Alternate NamesForm
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. QuestionnaireResponse.status
    Definition

    The current state of the questionnaire response.

    Shortin-progress | completed | amended | entered-in-error | stopped
    Comments

    Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

    Control1..1
    BindingThe codes SHALL be taken from QuestionnaireResponseStatushttp://hl7.org/fhir/ValueSet/questionnaire-answers-status|5.0.0
    (required to http://hl7.org/fhir/ValueSet/questionnaire-answers-status|5.0.0)

    Lifecycle status of the questionnaire response.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

    The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. QuestionnaireResponse.subject
    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.

    ShortThe subject of the questions
    Comments

    If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.

    Control10..1
    TypeReference(EE MPI Patient Verified, Resource)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Links the questionnaire response to the Patient context. May also affect access control.

    Alternate NamesPatient, Focus
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. QuestionnaireResponse.encounter
    Definition

    The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

    ShortEncounter the questionnaire response is part of
    Comments

    This will typically be the encounter the questionnaire response was created during, but some questionnaire responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission forms). A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.

    Control0..01
    TypeReference(Encounter)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Links the questionnaire response to the Encounter context. May also affect access control.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. QuestionnaireResponse.author
    Definition

    The individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

    ShortThe individual or device that received and recorded the answers
    Comments

    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. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.

    Control10..1
    TypeReference(EE MPI Patient Verified, PractitionerRole, Device, Practitioner, Patient, RelatedPerson, Organization)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    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, Performer
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. QuestionnaireResponse
    2. QuestionnaireResponse.meta
    4. QuestionnaireResponse.meta.profile
    Control1..1
    6. QuestionnaireResponse.implicitRules
    Control0..0
    8. QuestionnaireResponse.language
    Control1..?
    10. QuestionnaireResponse.contained
    Control0..0
    12. QuestionnaireResponse.extension
    Control1..?
    SlicingThis element introduces a set of slices on QuestionnaireResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 14. QuestionnaireResponse.extension:categories
      Slice Namecategories
      Control1..*
      TypeExtension(Tervise deklaratsiooni kasutusala) (Complex Extension)
      16. QuestionnaireResponse.modifierExtension
      Control0..0
      18. QuestionnaireResponse.basedOn
      Control0..0
      20. QuestionnaireResponse.partOf
      Control0..0
      22. QuestionnaireResponse.subject
      Control1..?
      TypeReference(EE MPI Patient Verified)
      24. QuestionnaireResponse.encounter
      Control0..0
      26. QuestionnaireResponse.author
      Control1..?
      TypeReference(EE MPI Patient Verified, PractitionerRole)
      28. QuestionnaireResponse.item
      30. QuestionnaireResponse.item.id
      Control0..0
      32. QuestionnaireResponse.item.extension
      Control0..0
      34. QuestionnaireResponse.item.modifierExtension
      Control0..0
      36. QuestionnaireResponse.item.definition
      Control0..0
      38. QuestionnaireResponse.item.answer
      40. QuestionnaireResponse.item.answer.id
      Control0..0
      42. QuestionnaireResponse.item.answer.extension
      Control0..0
      44. QuestionnaireResponse.item.answer.modifierExtension
      Control0..0

      Guidance on how to interpret the contents of this table can be foundhere

      0. QuestionnaireResponse
      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.

      ShortA structured set of questions and their answers
      Comments

      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.

      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate NamesForm, QuestionnaireAnswers
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. QuestionnaireResponse.id
      Definition

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

      ShortLogical id of this artifact
      Comments

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      4. QuestionnaireResponse.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. QuestionnaireResponse.meta.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeid
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      8. QuestionnaireResponse.meta.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on QuestionnaireResponse.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. QuestionnaireResponse.meta.versionId
        Definition

        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

        ShortVersion specific identifier
        Comments

        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

        Control0..1
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. QuestionnaireResponse.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortWhen the resource version last changed
        Comments

        This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control0..1
        Typeinstant
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. QuestionnaireResponse.meta.source
        Definition

        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

        ShortIdentifies where the resource comes from
        Comments

        The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

        Control0..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. QuestionnaireResponse.meta.profile
        Definition

        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

        ShortProfiles this resource claims to conform to
        Comments

        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

        Control1..1
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. QuestionnaireResponse.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortSecurity Labels applied to this resource
        Comments

        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from AllSecurityLabels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels)

        Security Labels from the Healthcare Privacy and Security Classification System.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. QuestionnaireResponse.meta.tag
        Definition

        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

        ShortTags applied to this resource
        Comments

        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingFor example codes, see CommonTags
        (example to http://hl7.org/fhir/ValueSet/common-tags)

        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. QuestionnaireResponse.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

        Control0..0
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. QuestionnaireResponse.language
        Definition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        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).

        Control1..1
        BindingThe codes SHALL be taken from AllLanguages
        (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

        IETF language tag for a human language

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. QuestionnaireResponse.text
        Definition

        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

        ShortText summary of the resource, for human interpretation
        Comments

        Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

        Control0..1
        This element is affected by the following invariants: dom-6
        TypeNarrative
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. QuestionnaireResponse.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

        ShortContained, inline 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

        Control0..0
        This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
        TypeResource
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        30. QuestionnaireResponse.extension
        Definition

        An Extension

        ShortExtension
        Control1..*
        TypeExtension
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on QuestionnaireResponse.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 32. QuestionnaireResponse.extension:categories
          Slice Namecategories
          Definition

          Tervise deklaratsiooni kasutusala ja selle kehtivuse periood

          ShortTervise deklaratsiooni kasutusala
          Control1..*
          TypeExtension(Tervise deklaratsiooni kasutusala) (Complex Extension)
          Is Modifierfalse
          Must Supportfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          34. QuestionnaireResponse.modifierExtension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          36. QuestionnaireResponse.identifier
          Definition

          Business identifiers assigned to this questionnaire response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

          ShortBusiness identifier for this set of answers
          Comments

          Note: This is a business identifier, not a resource identifier (see discussion).

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Allows identification of the questionnaire response as it is known by various participating systems and in a way that remains consistent across servers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. QuestionnaireResponse.basedOn
          Definition

          A plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

          ShortRequest fulfilled by this QuestionnaireResponse
          Control0..0
          TypeReference(CarePlan, ServiceRequest)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Supports traceability of responsibility for the questionnaire response and allows linkage of the response to the proposals/recommendations acted upon.

          Alternate Namesorder
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. QuestionnaireResponse.partOf
          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.

          ShortPart of referenced event
          Comments

          Not to be used to link an questionnaire response to an Encounter - use 'context' for that.

          Composition of questionnaire responses will be handled using the Assemble operation defined in the SDC IG. For relationships to referrals, and other types of requests, use basedOn.

          Control0..0
          TypeReference(Observation, Procedure)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. QuestionnaireResponse.questionnaire
          Definition

          The Questionnaire that defines and organizes the questions for which answers are being provided.

          ShortCanonical URL of Questionnaire being answered
          Comments

          If a QuestionnaireResponse references a Questionnaire that can be resolved, 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.). It is possible to have a QuestionnaireResponse whose 'questionnaire' element does not resolve. It is also possible for the questionnaire element to not have a value but only extensions (e.g. conveying the title or identifier for the questionnaire). This may happen for legacy data. If there is no formally defined Questionnaire, it is undefined what the 'correct' values for the linkId elements should be and it is possible that linkIds might be inconsistent for QuestionnaireResponses for the same form if captured by distinct systems.

          Control1..1
          Typecanonical(Questionnaire)
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

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

          Alternate NamesForm
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. QuestionnaireResponse.status
          Definition

          The current state of the questionnaire response.

          Shortin-progress | completed | amended | entered-in-error | stopped
          Comments

          Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

          Control1..1
          BindingThe codes SHALL be taken from QuestionnaireResponseStatus
          (required to http://hl7.org/fhir/ValueSet/questionnaire-answers-status|5.0.0)

          Lifecycle status of the questionnaire response.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

          The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. QuestionnaireResponse.subject
          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.

          ShortThe subject of the questions
          Comments

          If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.

          Control1..1
          TypeReference(EE MPI Patient Verified)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Links the questionnaire response to the Patient context. May also affect access control.

          Alternate NamesPatient, Focus
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. QuestionnaireResponse.encounter
          Definition

          The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

          ShortEncounter the questionnaire response is part of
          Comments

          This will typically be the encounter the questionnaire response was created during, but some questionnaire responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission forms). A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.

          Control0..0
          TypeReference(Encounter)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Links the questionnaire response to the Encounter context. May also affect access control.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. QuestionnaireResponse.authored
          Definition

          The date and/or time that this questionnaire response was last modified by the user - e.g. changing answers or revising status.

          ShortDate the answers were gathered
          Comments

          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.

          This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.

          Control0..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          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
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. QuestionnaireResponse.author
          Definition

          The individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

          ShortThe individual or device that received and recorded the answers
          Comments

          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. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.

          Control1..1
          TypeReference(EE MPI Patient Verified, PractitionerRole)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          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, Performer
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. QuestionnaireResponse.source
          Definition

          The individual or device that answered the questions about the subject.

          ShortThe individual or device that answered the questions
          Comments

          If not specified, no inference can be made about who provided the data. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance.

          Control0..1
          TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. QuestionnaireResponse.item
          Definition

          A group or question item from the original questionnaire for which answers are provided.

          ShortGroups and questions
          Comments

          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).\nWhen dealing with repeating items, each group repetition will be handled by a separate item. However, repeating questions are handled with a single question item and potentially multiple answers.

          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          qrs-1: Item cannot contain both item and answer ((answer.exists() and item.exists()).not())
          qrs-2: Repeated answers are combined in the answers array of a single item (repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue())
          58. QuestionnaireResponse.item.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..0
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          60. QuestionnaireResponse.item.extension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          62. QuestionnaireResponse.item.modifierExtension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          64. QuestionnaireResponse.item.linkId
          Definition

          The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

          ShortPointer to specific item from Questionnaire
          Control1..1
          This element is affected by the following invariants: qrs-2
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Requirements

          Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. QuestionnaireResponse.item.definition
          Definition

          A reference to an ElementDefinition that provides the details for the item.

          ShortElementDefinition - details for the item
          Comments

          The ElementDefinition must be in a StructureDefinition, 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].

          There is no need for this element if the item pointed to by the linkId has a definition listed.

          Control0..0
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          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.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. QuestionnaireResponse.item.text
          Definition

          Text that is displayed above the contents of the group or as the text of the question being answered.

          ShortName for group or question text
          Comments

          The text for an item SHOULD be identical to the text from the corresponding Questionnaire.item. This can't be strictly enforced because it's possible for the Questionnaire to be updated subsequent to the QuestionnaireResponse having been created, however the intention is that the text in the QuestionnaireResponse reflects what the user saw when completing the Questionnaire.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Requirements

          Allows the questionnaire response to be read without access to the questionnaire.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. QuestionnaireResponse.item.answer
          Definition

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

          ShortThe response(s) to the question
          Comments

          The value is nested because we cannot have a repeating structure that has variable type.

          Control0..*
          This element is affected by the following invariants: qrs-1, qrs-2
          TypeBackboneElement
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. QuestionnaireResponse.item.answer.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..0
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          74. QuestionnaireResponse.item.answer.extension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          76. QuestionnaireResponse.item.answer.modifierExtension
          Definition

          An Extension

          ShortExtension
          Control0..0
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          78. QuestionnaireResponse.item.answer.value[x]
          Definition

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

          ShortSingle-valued answer 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. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match.

          Control1..1
          This element is affected by the following invariants: qrs-2
          BindingFor example codes, see QuestionnaireAnswerCodes
          (example to http://hl7.org/fhir/ValueSet/questionnaire-answers)

          Binding this is problematic because one value set can't apply to both codes and quantities.

          TypeChoice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity(SimpleQuantity), Reference(Resource)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Requirements

          Ability to retain a single-valued answer to a question.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          80. QuestionnaireResponse.item.answer.item
          Definition

          Nested groups and/or questions found within this particular answer.

          ShortChild items of question
          Comments

          Only used when nesting beneath a question - see item.item for nesting beneath groups

          Control0..*
          TypeSeettp://hl7.org/fhir/StructureDefinition/QuestionnaireResponse#QuestionnaireResponse.item
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          82. QuestionnaireResponse.item.item
          Definition

          Sub-questions, sub-groups or display items nested beneath a group.

          ShortChild items of group item
          Comments

          Only used when nesting beneath a group - see item.answer.item for nesting beneath questions

          Control0..*
          TypeSeettp://hl7.org/fhir/StructureDefinition/QuestionnaireResponse#QuestionnaireResponse.item
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Requirements

          Reports can consist of complex nested groups.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))