Structured Data Capture
3.0.0 - STU 3 International flag

This page is part of the Structured Data Capture FHIR IG (v3.0.0: STU 3) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SDCQuestionnaireBehave - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the sdc-questionnaire-behave resource profile.

1. Questionnaire
Definition

Defines additional capabilities for controlling data entry and calculating values within the questionnaire.

Control0..*
Alternate NamesForm, CRF, Survey
InvariantsDefined on this element
dom-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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
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())
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
que-2: The link ids for groups and questions must be unique within the questionnaire (: descendants().linkId.isDistinct())
2. Questionnaire.id
Definition

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

Control0..1
Typestring
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.

3. Questionnaire.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.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Questionnaire.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.

Control0..1
Typeuri
Is Modifiertrue
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 it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Questionnaire.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Questionnaire.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.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Questionnaire.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
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. Questionnaire.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Questionnaire.extension:designNote
SliceNamedesignNote
Definition

Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Design Note) (Extension Type: markdown)
Comments

Allows capture of todos, rationale for design decisions, etc. It can also be used to capture comments about the completion of the form in general. Allows commentary to be captured during the process of answering a questionnaire (if not already supported by the form design) as well as after the form is completed. Comments are not part of the "data" of the form. If a form prompts for a comment, this should be captured in an answer, not in this element. Formal assessments of the QuestionnareResponse would use Observation.

InvariantsDefined on this element
ele-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())
10. Questionnaire.extension:terminologyServer
SliceNameterminologyServer
Definition

Indicates the terminology server(s) that are known to be capable of returning and potentially expanding the value set(s) associated with the whole questionnaire or a particular group or question within the questionnaire (depending on where the extension appears). If a full URL is not provided AND the requested query is a terminology operation (e.g. $lookup or $expand) the client SHOULD execute the operation against the preferredTerminologyServer rather than the local repository.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(PreferredTerminologyServer) (Extension Type: url)
Comments

This includes those referenced by answerValueSet as well as the unitValueSet extension.

InvariantsDefined on this element
ele-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())
11. Questionnaire.extension:performerType
SliceNameperformerType
Definition

Indicates the types of resources that can record answers to a Questionnaire. Open Issue: Should this extension be moved to core?

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(PerformerTypeExtension) (Extension Type: code)
Must Supporttrue
InvariantsDefined on this element
ele-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. Questionnaire.extension:assemble-expectation
SliceNameassemble-expectation
Definition

If present, indicates that this questionnaire has expectations with respect to assembly. Specifically, indicates whether this form requires assembly (i.e. it can't be used directly without invoking the $assemble operation operation on it) and/or whether it is intended for use only as a 'child' in an assembly process. The assembly processs might mean filling in item metadata based on information looked up from item.definitions and/or retrieving sub-questionnaires pointed to by sub-questionnaire extensions.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AssembleExpectation) (Extension Type: code)
Must Supporttrue
Comments

SDC-conformant Questionnaires SHALL declare this extension if they require an assembly process prior to use. If not declared, then the Questionnaire is not necessarily safe for use as a child form and does not require assembly prior to use.

InvariantsDefined on this element
ele-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())
13. Questionnaire.extension:entryMode
SliceNameentryMode
Definition

Indicates how questions within the questionnaire should be presented to the end-user. Specifically, differentiates whether the questions should be displayed one-at-a-time with no ability to adjust prior entries; one-at-a-time or continuously expanding where all questions up to the current question can be looked at and edited, or random, where all questions can be seen and the questions can be filled out in any order desired.

Control0..*
TypeExtension(EntryMode) (Extension Type: code)
Must Supporttrue
Comments

The prior-edit functionality can be accomplished by adding questions to the screen as each subsequent question is answered (resulting in all questions being displayed in a single screen) or with a view that shows only one question at a time but allows backward navigation to view and/or edit prior answers.

InvariantsDefined on this element
ele-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. Questionnaire.extension:submissionEndpoint
SliceNamesubmissionEndpoint
Definition

The base URL for the server to which questionnaire response associated with this questionnaire should be submitted. If multiple repetitions are present, the completed form should be sent to all listed endpoints.

Control0..*
TypeExtension(EndpointExtension) (Extension Type: uri)
Must Supporttrue
Comments

Indicates that the form has been designed with an expectation that it will be submitted to the specified URI. If multiple endpoints are specified, expectation is that answers are submitted to all endpoints.

If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site. If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules.

Endpoints may have expectations around authorization, etc. Some of this may be learned by consulting the CapabilityStatement associated with the endpoint.

InvariantsDefined on this element
ele-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())
15. Questionnaire.extension:signatureRequired
SliceNamesignatureRequired
Definition

Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse.

Control0..*
TypeExtension(signatureRequired) (Extension Type: CodeableConcept)
Comments

If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.)

The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension.

InvariantsDefined on this element
ele-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())
16. Questionnaire.extension:constraint
SliceNameconstraint
Definition

An invariant that must be satisfied before responses to the questionnaire can be considered "complete".

Control0..*
TypeExtension(constraint) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta)
Comments

This maps to the ElementDefinition.constraint element.

InvariantsDefined on this element
ele-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())
17. Questionnaire.extension:library
SliceNamelibrary
Definition

A reference to a library containing cql used in this Questionnaire.

Control0..*
TypeExtension(library) (Extension Type: canonical(Library))
InvariantsDefined on this element
ele-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())
18. Questionnaire.extension:launchContext
SliceNamelaunchContext
Definition

Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse.

Control0..*
TypeExtension(LaunchContextExtension) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta)
Comments

3 of these launch contexts are aligned with the existing SMART on FHIR "launch" contexts.

InvariantsDefined on this element
ele-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())
19. Questionnaire.extension:variable
SliceNamevariable
Definition

Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension.

Control0..*
TypeExtension(Variable) (Extension Type: Expression)
Requirements

Allows variables to be calculated higher in the context of a QuestionnaireResponse for use with enableWhen-expression.

Comments

Ordering of variable extension declarations is significant as variables declared in one repetition of this extension might be used in subsequent extension repetitions.

InvariantsDefined on this element
ele-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())
20. Questionnaire.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-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())
21. Questionnaire.url
Definition

An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.

Control1..1
Typeuri
Must Supporttrue
Requirements

… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.

Comments

The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Questionnaire.identifier
Definition

A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Questionnaire.version
Definition

The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Must Supporttrue
Comments

There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version].

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Questionnaire.name
Definition

A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1 This element is affected by the following invariants: inv-0
Typestring
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Questionnaire.title
Definition

A short, descriptive, user-friendly title for the questionnaire.

Control0..1
Typestring
Must Supporttrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Questionnaire.derivedFrom
Definition

The URL of a Questionnaire that this Questionnaire is based on.

Control0..*
Typecanonical(Questionnaire)
Requirements

Allows a Questionnaire to be created based on another Questionnaire.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Questionnaire.status
Definition

The status of this questionnaire. Enables tracking the life-cycle of the content.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus The lifecycle status of an artifact.

Typecode
Is Modifiertrue
Must Supporttrue
Comments

Allows filtering of questionnaires that are appropriate for use versus not.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Questionnaire.experimental
Definition

A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.

Comments

Allows filtering of questionnaires that are appropriate for use versus not.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Questionnaire.subjectType
Definition

The types of subjects that can be the subject of responses created for the questionnaire.

Control0..*
BindingThe codes SHALL be taken from ResourceType One of the resource types defined as part of this version of FHIR.

Typecode
Must Supporttrue
Requirements

A Questionnaire SHOULD specify the subject. However, it is optional to support legacy questionnaires.

Comments

If none are specified, then the subject is unlimited.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Questionnaire.date
Definition

The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.

Control0..1
TypedateTime
Alternate NamesRevision Date
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Questionnaire.publisher
Definition

The name of the organization or individual that published the questionnaire.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Questionnaire.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Comments

May be a web site, an email address, a telephone number, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Questionnaire.description
Definition

A free text natural language description of the questionnaire from a consumer's perspective.

Control0..1
Typemarkdown
Comments

This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Questionnaire.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Questionnaire.jurisdiction
Definition

A legal or geographic region in which the questionnaire is intended to be used.

Control0..*
BindingThe codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Comments

It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Questionnaire.purpose
Definition

Explanation of why this questionnaire is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Questionnaire.copyright
Definition

A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.

Alternate NamesLicense, Restrictions
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Questionnaire.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Control0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Questionnaire.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Control0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Questionnaire.effectivePeriod
Definition

The period during which the questionnaire content was or is planned to be in active use.

Control0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.

Comments

The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Questionnaire.code
Definition

An identifier for this question or group of questions in a particular terminology such as LOINC.

Control0..*
BindingFor example codes, see QuestionnaireQuestionCodes Codes for questionnaires, groups and individual questions.

TypeCoding
Requirements

Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Questionnaire.item
Definition

A particular question, question grouping or display text that is part of the questionnaire.

Control0..* This element is affected by the following invariants: que-3
TypeBackboneElement
Must Supporttrue
Comments

The content of the questionnaire is constructed from an ordered, hierarchical collection of items.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
que-1: Group items must have nested items, display items cannot have nested items (: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()))
que-10: Maximum length can only be declared for simple question types (: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty())
que-11: If one or more answerOption is present, initial[x] must be missing (: answerOption.empty() or initial.empty())
que-12: If there are more than one enableWhen, enableBehavior must be specified (: enableWhen.count() > 2 implies enableBehavior.exists())
que-13: Can only have multiple initial values for repeating items (: repeats=true or initial.count() <= 1)
que-3: Display items cannot have a "code" asserted (: type!='display' or code.empty())
que-4: A question cannot have both answerOption and answerValueSet (: answerOption.empty() or answerValueSet.empty())
que-5: Only 'choice' and 'open-choice' items can have answerValueSet (: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()))
que-6: Required and repeat aren't permitted for display items (: type!='display' or (required.empty() and repeats.empty()))
que-8: Initial values can't be specified for groups or display items (: (type!='group' and type!='display') or initial.empty())
que-9: Read-only can't be specified for "display" items (: type!='display' or readOnly.empty())
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. (: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()))
sdc-behave-1: An item cannot have both initial.value and initialExpression (: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty())
sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression (: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty())
43. Questionnaire.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.

Control0..1
Typestring
44. Questionnaire.item.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
45. Questionnaire.item.extension:designNote
SliceNamedesignNote
Definition

Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Design Note) (Extension Type: markdown)
Comments

Allows capture of todos, rationale for design decisions, etc. It can also be used to capture comments about specific groups or questions within it. Allows commentary to be captured during the process of answering a questionnaire (if not already supported by the form design) as well as after the form is completed. Comments are not part of the "data" of the form. If a form prompts for a comment, this should be captured in an answer, not in this element. Formal assessments of the QuestionnareResponse would use Observation.

InvariantsDefined on this element
ele-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())
46. Questionnaire.item.extension:terminologyServer
SliceNameterminologyServer
Definition

Indicates the terminology server(s) that are known to be capable of returning and potentially expanding the value set(s) associated with the whole questionnaire or a particular group or question within the questionnaire (depending on where the extension appears). If a full URL is not provided AND the requested query is a terminology operation (e.g. $lookup or $expand) the client SHOULD execute the operation against the preferredTerminologyServer rather than the local repository.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(PreferredTerminologyServer) (Extension Type: url)
Comments

This includes those referenced by answerValueSet as well as the unitValueSet extension.

InvariantsDefined on this element
ele-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())
47. Questionnaire.item.extension:answerExpression
SliceNameanswerExpression
Definition

An expression (FHIRPath, CQL or FHIR Query) that resolves to a list of permitted answers for the question item or that establishes context for a group item. The user may select from among the list to choose answers for the question.

Control0..1
TypeExtension(AnswerExpressionExtension) (Extension Type: Expression)
Must Supporttrue
Comments

This is only permitted when the containing item does NOT have any answerOption or answerValueSet elements. The results of the expression must correspond to the item type of the question the element appears on or must correspond to a resource, backbone element or complex data type for a group item. Resources are considered a match for the Reference item type. Quantity can be a match for decimal and integer items so long as a questionnaire-unit extension is present.

InvariantsDefined on this element
ele-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())
48. Questionnaire.item.extension:usageMode
SliceNameusageMode
Definition

Identifies that the specified element should only appear in certain "modes" of operation.

Control0..1
TypeExtension(usageMode) (Extension Type: code)
Must Supporttrue
InvariantsDefined on this element
ele-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())
49. Questionnaire.item.extension:itemSignatureRequired
SliceNameitemSignatureRequired
Definition

Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse.

Control0..*
TypeExtension(signatureRequired) (Extension Type: CodeableConcept)
Comments

If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.)

The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension.

InvariantsDefined on this element
ele-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())
50. Questionnaire.item.extension:itemMinOccurs
SliceNameitemMinOccurs
Definition

The minimum number of times the group must appear, or the minimum number of answers for a question - when greater than 1.

Control0..1
TypeExtension(minOccurs) (Extension Type: integer)
Must Supporttrue
Comments

Default assumption for "required" elements is minOccurs=1.

InvariantsDefined on this element
ele-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())
51. Questionnaire.item.extension:itemMinOccurs.id
Definition

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

Control0..1
Typestring
52. Questionnaire.item.extension:itemMinOccurs.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
53. Questionnaire.item.extension:itemMinOccurs.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
54. Questionnaire.item.extension:itemMinOccurs.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
Typeinteger
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Questionnaire.item.extension:itemMinOccurs.value[x].id
Definition

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

Control0..1
Typestring
56. Questionnaire.item.extension:itemMinOccurs.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
57. Questionnaire.item.extension:itemMinOccurs.value[x].extension:itemMinOccursCalculated
SliceNameitemMinOccursCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
58. Questionnaire.item.extension:itemMinOccurs.value[x].extension:itemMinOccursExpression
SliceNameitemMinOccursExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
59. Questionnaire.item.extension:itemMinOccurs.value[x].value
Definition

The actual value

Control0..1
Typeinteger
60. Questionnaire.item.extension:itemMaxOccurs
SliceNameitemMaxOccurs
Definition

The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited.

Control0..1
TypeExtension(maxOccurs) (Extension Type: integer)
Must Supporttrue
Comments

Only relevant if the element has repeats=true and there's a need to constrain the number of allowed repetitions.

InvariantsDefined on this element
ele-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())
61. Questionnaire.item.extension:itemMaxOccurs.id
Definition

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

Control0..1
Typestring
62. Questionnaire.item.extension:itemMaxOccurs.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
63. Questionnaire.item.extension:itemMaxOccurs.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
64. Questionnaire.item.extension:itemMaxOccurs.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
Typeinteger
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Questionnaire.item.extension:itemMaxOccurs.value[x].id
Definition

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

Control0..1
Typestring
66. Questionnaire.item.extension:itemMaxOccurs.value[x].extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
67. Questionnaire.item.extension:itemMaxOccurs.value[x].extension:itemMaxOccursCalculated
SliceNameitemMaxOccursCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
68. Questionnaire.item.extension:itemMaxOccurs.value[x].extension:itemMaxOccursExpression
SliceNameitemMaxOccursExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
69. Questionnaire.item.extension:itemMaxOccurs.value[x].value
Definition

The actual value

Control0..1
Typeinteger
70. Questionnaire.item.extension:minLength
SliceNameminLength
Definition

The minimum number of characters that must be present in the simple data type to be considered a "valid" instance.

Control0..1
TypeExtension(minLength) (Extension Type: integer)
Must Supporttrue
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data.

InvariantsDefined on this element
ele-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())
71. Questionnaire.item.extension:regex
SliceNameregex
Definition

A regular expression that defines the syntax for the data element to be considered valid.

Control0..1
TypeExtension(regex) (Extension Type: string)
Must Supporttrue
InvariantsDefined on this element
ele-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())
72. Questionnaire.item.extension:minValue
SliceNameminValue
Definition

The inclusive lower bound on the range of allowed values for the data element.

Control0..1
TypeExtension(minValue) (Extension Type: Choice of: date, dateTime, time, decimal, integer)
Must Supporttrue
Comments

Data type specified must be the same as the data type for the data element.

InvariantsDefined on this element
ele-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())
73. Questionnaire.item.extension:minValue.id
Definition

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

Control0..1
Typestring
74. Questionnaire.item.extension:minValue.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
75. Questionnaire.item.extension:minValue.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/minValue
76. Questionnaire.item.extension:minValue.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
TypeChoice of: date, dateTime, time, decimal, integer
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Questionnaire.item.extension:minValue.value[x].id
Definition

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

Control0..1
Typestring
78. Questionnaire.item.extension:minValue.value[x].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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
79. Questionnaire.item.extension:minValue.value[x].extension:minValueCalculated
SliceNameminValueCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
80. Questionnaire.item.extension:maxValue
SliceNamemaxValue
Definition

The inclusive upper bound on the range of allowed values for the data element.

Control0..1
TypeExtension(maxValue) (Extension Type: Choice of: date, dateTime, time, instant, decimal, integer)
Must Supporttrue
Comments

Data type specified must be the same as the data type for the data element.

InvariantsDefined on this element
ele-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())
81. Questionnaire.item.extension:maxValue.id
Definition

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

Control0..1
Typestring
82. Questionnaire.item.extension:maxValue.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
83. Questionnaire.item.extension:maxValue.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/maxValue
84. Questionnaire.item.extension:maxValue.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
TypeChoice of: date, dateTime, time, instant, decimal, integer
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Questionnaire.item.extension:maxValue.value[x].id
Definition

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

Control0..1
Typestring
86. Questionnaire.item.extension:maxValue.value[x].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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
87. Questionnaire.item.extension:maxValue.value[x].extension:maxValueCalculated
SliceNamemaxValueCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
88. Questionnaire.item.extension:minQuantity
SliceNameminQuantity
Definition

The inclusive lower bound on the range of allowed values for a 'quantity' type question. Open Issue: Revisit whether this should be folded into the regular minValue extension once there are better capabilities around defining conformance expectations regarding extensions.

Control0..1
TypeExtension(MinQuantityExtension) (Extension Type: Quantity)
Comments

This must only be used if the set of permitted units is constrained to UCUM codes and the minimum checks will be performed by converting the answer.valueQuantity to the same units as the minQuantity unit prior to comparison.

InvariantsDefined on this element
ele-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())
89. Questionnaire.item.extension:minQuantity.id
Definition

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

Control0..1
Typestring
90. Questionnaire.item.extension:minQuantity.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
91. Questionnaire.item.extension:minQuantity.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
92. Questionnaire.item.extension:minQuantity.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. Questionnaire.item.extension:minQuantity.value[x].id
Definition

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

Control0..1
Typestring
94. Questionnaire.item.extension:minQuantity.value[x].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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
95. Questionnaire.item.extension:minQuantity.value[x].extension:minQuantityCalculated
SliceNameminQuantityCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
96. Questionnaire.item.extension:minQuantity.value[x].value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control0..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
97. Questionnaire.item.extension:minQuantity.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented.

Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. Questionnaire.item.extension:minQuantity.value[x].unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. Questionnaire.item.extension:minQuantity.value[x].system
Definition

The identification of the system that provides the coded form of the unit.

Control0..1 This element is affected by the following invariants: qty-3
Typeuri
Requirements

Need to know the system that defines the coded form of the unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. Questionnaire.item.extension:minQuantity.value[x].code
Definition

A computer processable form of the unit in some unit representation system.

Control0..1
Typecode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
101. Questionnaire.item.extension:maxQuantity
SliceNamemaxQuantity
Definition

The inclusive upper bound on the range of allowed values for a 'quantity' type question. Open Issue: Revisit whether this should be folded into the regular maxValue extension once there are better capabilities around defining conformance expectations regarding extensions.

Control0..1
TypeExtension(MaxQuantityExtension) (Extension Type: Quantity)
Comments

This must only be used if the set of permitted units is constrained to UCUM codes and the maximum checks will be performed by converting the answer.valueQuantity to the same units as the maxQuantity unit prior to comparison.

InvariantsDefined on this element
ele-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())
102. Questionnaire.item.extension:maxQuantity.id
Definition

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

Control0..1
Typestring
103. Questionnaire.item.extension:maxQuantity.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
104. Questionnaire.item.extension:maxQuantity.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
105. Questionnaire.item.extension:maxQuantity.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeQuantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. Questionnaire.item.extension:maxQuantity.value[x].id
Definition

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

Control0..1
Typestring
107. Questionnaire.item.extension:maxQuantity.value[x].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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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 Questionnaire.item.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
108. Questionnaire.item.extension:maxQuantity.value[x].extension:maxQuantityCalculated
SliceNamemaxQuantityCalculated
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..1
TypeExtension(calculatedValue) (Extension Type: string)
InvariantsDefined on this element
ele-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())
109. Questionnaire.item.extension:maxQuantity.value[x].value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control0..1
Typedecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
110. Questionnaire.item.extension:maxQuantity.value[x].comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingThe codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented.

Typecode
Is Modifiertrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
111. Questionnaire.item.extension:maxQuantity.value[x].unit
Definition

A human-readable form of the unit.

Control0..1
Typestring
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
112. Questionnaire.item.extension:maxQuantity.value[x].system
Definition

The identification of the system that provides the coded form of the unit.

Control0..1 This element is affected by the following invariants: qty-3
Typeuri
Requirements

Need to know the system that defines the coded form of the unit.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. Questionnaire.item.extension:maxQuantity.value[x].code
Definition

A computer processable form of the unit in some unit representation system.

Control0..1
Typecode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
114. Questionnaire.item.extension:maxDecimalPlaces
SliceNamemaxDecimalPlaces
Definition

Identifies the maximum number of decimal places that may be specified for the data element.

Control0..1
TypeExtension(maxDecimalPlaces) (Extension Type: integer)
Must Supporttrue
InvariantsDefined on this element
ele-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())
115. Questionnaire.item.extension:mimeType
SliceNamemimeType
Definition

Identifies the kind(s) of attachment allowed to be sent for an element.

Control0..*
TypeExtension(mimeType) (Extension Type: code)
Must Supporttrue
Comments

This extension only has meaning if the element has a type of Attachment.

InvariantsDefined on this element
ele-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())
116. Questionnaire.item.extension:maxSize
SliceNamemaxSize
Definition

For attachment answers, indicates the maximum size an attachment can be.

Control0..1
TypeExtension(maxSize) (Extension Type: decimal)
Comments

This extension only has meaning if the element has a type of Attachment.

InvariantsDefined on this element
ele-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())
117. Questionnaire.item.extension:answerOptionsToggleExpression
SliceNameanswerOptionsToggleExpression
Definition

A complex expression that provides a list of the allowed options that should be enabled or disabled based on the evaluation of a provided expression. It allows toggling of allowed answers based on context, including the answers provided to other expressions.

Control0..*
TypeExtension(AnswerOptionsToggleExpressionExtension) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta)
Must Supporttrue
Comments

For example, this allows a list of conditions to be modified based on the gender of the patient

InvariantsDefined on this element
ele-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())
118. Questionnaire.item.extension:unitOption
SliceNameunitOption
Definition

A unit that the user may choose when providing a quantity value.

Control0..*
TypeExtension(unitOption) (Extension Type: Coding)
Must Supporttrue
Comments

Provide either unit-option(s) or unit-valueSet. In the absence of either, any unit is valid.

InvariantsDefined on this element
ele-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())
119. Questionnaire.item.extension:unitValueSet
SliceNameunitValueSet
Definition

A set of units that the user may choose when providing a quantity value.

Control0..1
TypeExtension(unitValueSet) (Extension Type: canonical(ValueSet))
Must Supporttrue
Comments

Provide either unit-option(s) or unit-valueSet. In the absence of either, any unit is valid.

InvariantsDefined on this element
ele-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())
120. Questionnaire.item.extension:unitOpen
SliceNameunitOpen
Definition

Indicates whether the list of supported units (conveyed in other extensions) are the exhaustive list from which the user must choose or whether they're able to select alternate codes or specify a string.

Control0..1
TypeExtension(UnitOpen) (Extension Type: code)
InvariantsDefined on this element
ele-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())
121. Questionnaire.item.extension:unitSupplementalSystem
SliceNameunitSupplementalSystem
Definition

If the questionnaire-unit-open extension indicates that additional units other than the set of options provided for the question are allowed, this indicates the code system those units are expected to be drawn from. This extension SHOULD be present on any question where questionare-unit-open allows additional coded values.

Control0..1
TypeExtension(UnitSupplementalSystem) (Extension Type: canonical)
InvariantsDefined on this element
ele-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())
122. Questionnaire.item.extension:allowedResource
SliceNameallowedResource
Definition

Where the type for a question is "Reference", indicates a type of resource that is permitted.

Control0..*
TypeExtension(referenceResource) (Extension Type: code)
Must Supporttrue
Comments

This extension only has meaning if the question.type = Reference. If no allowedResource extensions are present, the presumption is that any type of resource is permitted. If multiple are present, then any of the specified types are permitted.

InvariantsDefined on this element
ele-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())
123. Questionnaire.item.extension:allowedProfile
SliceNameallowedProfile
Definition

Where the type for a question is "Reference", indicates a profile that the resource instances pointed to in answers to this question must be valid against.

Control0..*
TypeExtension(referenceProfile) (Extension Type: canonical(StructureDefinition))
Comments

If multiple profiles are present, then the resource must be valid against at least one of them.

InvariantsDefined on this element
ele-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())
124. Questionnaire.item.extension:candidateExpression
SliceNamecandidateExpression
Definition

A FHIRPath or CQL expression, or FHIR Query that resolves to a list of candidate answers for the question item or that establishes context for a group item. The user may select from among the candidates to choose answers for the question.

Control0..1
TypeExtension(CandidateExpressionExtension) (Extension Type: Expression)
Comments

The results of the expression must correspond to the item type of the question the element appears on or must correspond to a resource, backbone element or complex data type for a group item. Resources are considered a match for the Reference item type. Quantity can be a match for decimal and integer items so long as a questionnaire-unit extension is present.

InvariantsDefined on this element
ele-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())
125. Questionnaire.item.extension:lookupQuestionnaire
SliceNamelookupQuestionnaire
Definition

For items of type reference, the reference can be populated either by picking an existing entity or by creating a new one. In the latter case, this Questionnaire allows specifying the Questionnaire to use in creating the target instance. Typically this will result in a QuestionnaireResponse that can be extracted to produce the desired resource. However, if the target resource for the reference is a QuestionnaireResponse, then the QuestionnaireResponse resulting from the Questionnaire can be referenced directly.

Control0..1
TypeExtension(LookupQuestionnaireExtension) (Extension Type: canonical)
InvariantsDefined on this element
ele-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())
126. Questionnaire.item.extension:itemConstraint
SliceNameitemConstraint
Definition

An invariant that must be satisfied before responses to the questionnaire can be considered "complete".

Control0..*
TypeExtension(constraint) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta)
Comments

This maps to the ElementDefinition.constraint element.

InvariantsDefined on this element
ele-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())
127. Questionnaire.item.extension:initialExpression
SliceNameinitialExpression
Definition

Initial value for a question answer as determined by an evaluated expression.

Control0..1
TypeExtension(InitialExpressionExtension) (Extension Type: Expression)
Comments

Initial value is only calculated at the time the QuestionnaireResponse is first generated.

InvariantsDefined on this element
ele-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())
128. Questionnaire.item.extension:calculatedExpression
SliceNamecalculatedExpression
Definition

Calculated value for a question answer as determined by an evaluated expression.

Control0..1
TypeExtension(CalculatedExpressionExtension) (Extension Type: Expression)
Comments

Calculated value is updated as other answers in the QuestionnaireResponse are filled in.

InvariantsDefined on this element
ele-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())
129. Questionnaire.item.extension:enableWhenExpression
SliceNameenableWhenExpression
Definition

An expression that returns a boolean value for whether to enable the item.

Control0..1
TypeExtension(EnableWhenExpressionExtension) (Extension Type: Expression)
Must Supporttrue
Comments

This is only permitted when the containing item does NOT have any enableWhen elements.

InvariantsDefined on this element
ele-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())
130. Questionnaire.item.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Control0..*
TypeExtension
Is Modifiertrue
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, 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.

InvariantsDefined on this element
ele-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())
131. Questionnaire.item.linkId
Definition

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

Control1..1
Typestring
Must Supporttrue
Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Comments

This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
132. Questionnaire.item.definition
Definition

This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:

  • code (ElementDefinition.code)
  • type (ElementDefinition.type)
  • required (ElementDefinition.min)
  • repeats (ElementDefinition.max)
  • maxLength (ElementDefinition.maxLength)
  • answerValueSet (ElementDefinition.binding)
  • options (ElementDefinition.binding).
Control0..1
Typeuri
Requirements

A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.

Comments

The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
133. Questionnaire.item.code
Definition

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

Control0..* This element is affected by the following invariants: que-3
BindingFor example codes, see QuestionnaireQuestionCodes Codes for questionnaires, groups and individual questions.

TypeCoding
Requirements

Allows linking of groups of questions to formal terminologies.

Comments

The value may come from the ElementDefinition referred to by .definition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
134. Questionnaire.item.prefix
Definition

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

Control0..1
Typestring
Must Supporttrue
Requirements

Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.

Alternate Nameslabel
Comments

These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
135. Questionnaire.item.text
Definition

The name of a section, the text of a question or text content for a display item.

Control0..1
Typestring
Must Supporttrue
Comments

When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
136. Questionnaire.item.type
Definition

The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

Control1..1
BindingThe codes SHALL be taken from QuestionnaireItemType Distinguishes groups from questions and display text and indicates data type for questions.

Typecode
Must Supporttrue
Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Time is handled using "string". File is handled using Attachment. (Content can be sent as a contained binary).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
137. Questionnaire.item.enableWhen
Definition

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Control0..*
TypeBackboneElement
Is Modifiertrue
Requirements

Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.

Comments

If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
que-7: If the operator is 'exists', the value must be a boolean (: operator = 'exists' implies (answer is Boolean))
138. Questionnaire.item.enableWhen.id
Definition

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

Control0..1
Typestring
139. Questionnaire.item.enableWhen.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
140. Questionnaire.item.enableWhen.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Control0..*
TypeExtension
Is Modifiertrue
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, 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.

InvariantsDefined on this element
ele-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())
141. Questionnaire.item.enableWhen.question
Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Control1..1
Typestring
Must Supporttrue
Comments

If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
142. Questionnaire.item.enableWhen.operator
Definition

Specifies the criteria by which the question is enabled.

Control1..1
BindingThe codes SHALL be taken from QuestionnaireItemOperator The criteria by which a question is enabled.

Typecode
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
143. Questionnaire.item.enableWhen.answer[x]
Definition

A value that the referenced question is tested using the specified operator in order for the item to be enabled.

Control1..1 This element is affected by the following invariants: que-7
BindingFor example codes, see QuestionnaireAnswerCodes Allowed values to answer questions.

TypeChoice of: boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
144. Questionnaire.item.enableBehavior
Definition

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Control0..1 This element is affected by the following invariants: que-12
BindingThe codes SHALL be taken from EnableWhenBehavior Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Typecode
Must Supporttrue
Comments

This element must be specified if more than one enableWhen value is provided.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
145. Questionnaire.item.required
Definition

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Control0..1 This element is affected by the following invariants: que-6
Typeboolean
Must Supporttrue
Comments

Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.

Meaning if MissingItems are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
146. Questionnaire.item.required.id
Definition

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

Control0..1
Typestring
147. Questionnaire.item.required.extension
Definition

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

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
148. Questionnaire.item.required.value
Definition

The actual value

Control0..1
Typeboolean
149. Questionnaire.item.required.value.id
Definition

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

Control0..1
Typestring
150. Questionnaire.item.required.value.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.required.value.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
151. Questionnaire.item.required.value.extension:requiredExpression
SliceNamerequiredExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
152. Questionnaire.item.required.value.value
Definition

The actual value

Control0..1
Typeboolean
153. Questionnaire.item.repeats
Definition

An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items)

Control0..1 This element is affected by the following invariants: que-6
Typeboolean
Must Supporttrue
Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Comments

If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.

The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.

The value may come from the ElementDefinition referred to by .definition.

Meaning if MissingItems are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
154. Questionnaire.item.repeats.id
Definition

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

Control0..1
Typestring
155. Questionnaire.item.repeats.extension
Definition

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

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
156. Questionnaire.item.repeats.value
Definition

The actual value

Control0..1
Typeboolean
157. Questionnaire.item.repeats.value.id
Definition

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

Control0..1
Typestring
158. Questionnaire.item.repeats.value.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.repeats.value.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
159. Questionnaire.item.repeats.value.extension:repeatsExpression
SliceNamerepeatsExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
160. Questionnaire.item.repeats.value.value
Definition

The actual value

Control0..1
Typeboolean
161. Questionnaire.item.readOnly
Definition

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

Control0..1 This element is affected by the following invariants: que-9
Typeboolean
Must Supporttrue
Requirements

Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.

Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
162. Questionnaire.item.readOnly.id
Definition

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

Control0..1
Typestring
163. Questionnaire.item.readOnly.extension
Definition

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

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
164. Questionnaire.item.readOnly.value
Definition

The actual value

Control0..1
Typeboolean
165. Questionnaire.item.readOnly.value.id
Definition

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

Control0..1
Typestring
166. Questionnaire.item.readOnly.value.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.readOnly.value.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
167. Questionnaire.item.readOnly.value.extension:readOnlyExpression
SliceNamereadOnlyExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
168. Questionnaire.item.readOnly.value.value
Definition

The actual value

Control0..1
Typeboolean
169. Questionnaire.item.maxLength
Definition

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

Control0..1 This element is affected by the following invariants: que-10
Typeinteger
Must Supporttrue
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
170. Questionnaire.item.answerValueSet
Definition

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

Control0..1 This element is affected by the following invariants: que-4, que-5
Typecanonical(SDCValueSet)
Must Supporttrue
Comments

LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
171. Questionnaire.item.answerValueSet.id
Definition

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

Control0..1
Typestring
172. Questionnaire.item.answerValueSet.extension
Definition

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

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
173. Questionnaire.item.answerValueSet.value
Definition

Primitive value for canonical

Control0..1
Typestring
174. Questionnaire.item.answerValueSet.value.id
Definition

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

Control0..1
Typestring
175. Questionnaire.item.answerValueSet.value.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.answerValueSet.value.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
176. Questionnaire.item.answerValueSet.value.extension:answerValueSetExpression
SliceNameanswerValueSetExpression
Definition

An expression that, when evaluated, provides the value for the element on which it appears.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(expression) (Extension Type: Expression)
Must Supporttrue
InvariantsDefined on this element
ele-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())
177. Questionnaire.item.answerValueSet.value.value
Definition

The actual value

Control0..1
Typestring
Max Length1048576
178. Questionnaire.item.answerOption
Definition

One of the permitted answers for a "choice" or "open-choice" question.

Control0..* This element is affected by the following invariants: que-4, que-5
TypeBackboneElement
Must Supporttrue
Comments

This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
179. Questionnaire.item.answerOption.id
Definition

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

Control0..1
Typestring
180. Questionnaire.item.answerOption.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
ele-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 Questionnaire.item.answerOption.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
181. Questionnaire.item.answerOption.extension:optionExclusive
SliceNameoptionExclusive
Definition

If true, indicates that if this answerOption is selected, no other possible answers may be selected, even if the item is a repeating question.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(optionExclusive) (Extension Type: boolean)
Must Supporttrue
InvariantsDefined on this element
ele-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())
182. Questionnaire.item.answerOption.extension:ordinalValue
SliceNameordinalValue
Definition

A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Ordinal Value) (Extension Type: decimal)
Must Supporttrue
Comments

Scores are commonly encountered in various clinical assessment scales. Assigning a value to a concept should generally be done in a formal code system that defines the value, or in an applicable value set for the concept, but some concepts do not have a formal definition (or are not even represented as a concept formally, especially in Questionnaires, so this extension is allowed to appear ouside those preferred contexts. Scores may even be assigned arbitrarily during use (hence, on Coding). The value may be constrained to an integer in some contexts of use. Todo: Scoring algorithms may also be defined directly, but how this is done is not yet defined.

InvariantsDefined on this element
ele-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())
183. Questionnaire.item.answerOption.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Control0..*
TypeExtension
Is Modifiertrue
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, 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.

InvariantsDefined on this element
ele-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())
184. Questionnaire.item.answerOption.value[x]
Definition

A potential answer that's allowed as the answer to this question.

Control1..1
BindingFor example codes, see QuestionnaireAnswerCodes Allowed values to answer questions.

TypeChoice of: integer, date, time, string, Coding, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Comments

The data type of the value must agree with the item.type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
185. Questionnaire.item.answerOption.initialSelected
Definition

Indicates whether the answer value is selected when the list of possible answers is initially shown.

Control0..1
Typeboolean
Comments

Use this instead of initial[v] if answerValueSet is present.

Meaning if MissingOnly selected items explicitly marked to be selected
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
186. Questionnaire.item.initial
Definition

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

Control0..* This element is affected by the following invariants: que-8, que-13
TypeBackboneElement
Must Supporttrue
Requirements

In some workflows, having defaults saves time.

Comments

The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
187. Questionnaire.item.initial.id
Definition

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

Control0..1
Typestring
188. Questionnaire.item.initial.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
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.

InvariantsDefined on this element
ele-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())
189. Questionnaire.item.initial.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

Control0..*
TypeExtension
Is Modifiertrue
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, 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.

InvariantsDefined on this element
ele-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())
190. Questionnaire.item.initial.value[x]
Definition

The actual value to for an initial answer.

Control1..1
BindingFor example codes, see QuestionnaireAnswerCodes Allowed values to answer questions.

TypeChoice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Comments

The type of the initial value must be consistent with the type of the item.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
191. Questionnaire.item.item
Definition

Text, questions and other groups to be nested beneath a question or group.

Control0..* This element is affected by the following invariants: que-1
TypeSee ttp://hl7.org/fhir/StructureDefinition/Questionnaire#Questionnaire.item
Must Supporttrue
Requirements

Reports can consist of complex nested groups.

Comments

There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))