NHS England FHIR Implementation Guide (deprecated)

NHSDigital-Questionnaire

Important: Experimental. This page is for illustration of a concept

Conformance url	FHIR Module	Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Questionnaire		draft

with Questionnaire

NHSDigitalQuestionnaire (Questionnaire)

There are no (further) constraints on this element

Element id

Questionnaire

Short description

A structured set of questions

Alternate names

Form, CRF, Survey

Definition

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
que-2: The link ids for groups and questions must be unique within the questionnaire
descendants().linkId.isDistinct()
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Mappings

rim: Entity. Role, or Act
workflow: Definition
rim: Observation[moodCode=DEF]

0..1

There are no (further) constraints on this element

Element id

Questionnaire.id

Short description

Logical id of this artifact

Definition

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

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

Questionnaire.meta

Short description

Metadata about the resource

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. 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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Questionnaire.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Questionnaire.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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

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.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

url

S Σ

0..1

uri

Element id

Questionnaire.url

Short description

Canonical identifier for this questionnaire, represented as a URI (globally unique)

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.

   "url": "https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption",

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.url
w5: FiveWs.identifier
rim: .identifier[scope=BUSN;reliability=ISS]

identifier

0..*

Identifier

There are no (further) constraints on this element

Element id

Questionnaire.identifier

Short description

Additional identifier for the questionnaire

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.

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Definition.identifier
w5: FiveWs.identifier
rim: .identifier
objimpl: no-gen-base

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Questionnaire.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference()

There are no (further) constraints on this element

Element id

Questionnaire.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference()

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

version

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.version

Short description

Business version of the questionnaire

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.

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

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.version
w5: FiveWs.version
rim: N/A (to add?)

name

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.name

Short description

Name for this questionnaire (computer friendly)

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-0

Constraints

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

Mappings

rim: n/a
rim: N/A

title

S Σ

0..1

string

Element id

Questionnaire.title

Short description

Name for this questionnaire (human friendly)

Definition

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

 "title": "COVID Vaccinnation Medical Exemption",

Comments

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

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.title
rim: .title

derivedFrom

0..*

canonical()

There are no (further) constraints on this element

Element id

Questionnaire.derivedFrom

Short description

Instantiates protocol or definition

Definition

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

Requirements

Allows a Questionnaire to be created based on another Questionnaire.

Comments

see Canonical References

Data type

canonical()

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.derivedFrom
rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]

status

S Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.status

Short description

draft | active | retired | unknown

Definition

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

Comments

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

Data type

code

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.status
w5: FiveWs.status
rim: .status

experimental

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.experimental

Short description

For testing purposes, not real usage

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.

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.experimental
w5: FiveWs.class
rim: N/A

subjectType

S Σ

0..*

codeBinding

Element id

Questionnaire.subjectType

Short description

Resource that can be subject of QuestionnaireResponse

Definition

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

 "subjectType": [
        "Patient"
    ],

Comments

If none are specified, then the subject is unlimited.

Data type

code

Binding

One of the resource types defined as part of this version of FHIR.

ResourceType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.subject[x]
rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode

date

0..1

dateTime

There are no (further) constraints on this element

Element id

Questionnaire.date

Short description

Date last changed

Alternate names

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

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.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.date
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

publisher

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.publisher

Short description

Name of the publisher (organization or individual)

Definition

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.publisher
w5: FiveWs.witness
rim: .participation[typeCode=AUT].role

contact

0..*

ContactDetail

There are no (further) constraints on this element

Element id

Questionnaire.contact

Short description

Contact details for the publisher

Definition

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

Comments

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

Data type

ContactDetail

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.contact
rim: .participation[typeCode=CALLBCK].role

description

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.description

Short description

Natural language description of the questionnaire

Definition

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

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

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.description
rim: .text

useContext

0..*

UsageContext

There are no (further) constraints on this element

Element id

Questionnaire.useContext

Short description

The context that the content is intended to support

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.

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.

Data type

UsageContext

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.useContext
rim: N/A (to add?)

jurisdiction

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.jurisdiction

Short description

Intended jurisdiction for questionnaire (if applicable)

Definition

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

Comments

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

Data type

CodeableConcept

Binding

Countries and regions within which this artifact is targeted for use.

Jurisdiction ValueSet (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Definition.jurisdiction
rim: N/A (to add?)

purpose

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.purpose

Short description

Why this questionnaire is defined

Definition

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

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.

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.purpose
w5: FiveWs.why[x]
rim: .reasonCode.text
objimpl: no-gen-base

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.copyright

Short description

Use and/or publishing restrictions

Alternate names

License, Restrictions

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.

Requirements

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

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.copyright
rim: N/A (to add?)
objimpl: no-gen-base

approvalDate

0..1

date

There are no (further) constraints on this element

Element id

Questionnaire.approvalDate

Short description

When the questionnaire was approved by publisher

Definition

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

Comments

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

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.approvalDate
rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
objimpl: no-gen-base

lastReviewDate

0..1

date

There are no (further) constraints on this element

Element id

Questionnaire.lastReviewDate

Short description

When the questionnaire was last reviewed

Definition

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

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.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.lastReviewDate
rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
objimpl: no-gen-base

effectivePeriod

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Questionnaire.effectivePeriod

Short description

When the questionnaire is expected to be used

Definition

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

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Definition.effectivePeriod
rim: N/A (to add?)
objimpl: no-gen-base

code

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Questionnaire.code

Short description

Concept that represents the overall questionnaire

Definition

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

Requirements

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

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

Coding

Binding

A set of codes that define questions or groups of questions, consisting of the entirety of the SNOMED CT UK Coding System. This set of codes may not necessarily be complete or appropriate and may require further discussion in the future.

(preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
rim: .code

item

S C

1..*

BackboneElement

Element id

Questionnaire.item

Short description

Questions and sections within the Questionnaire

Definition

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

Comments

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

"item": [
        {
            "type": "choice",
            "required": true,
            "linkId": "exemptionStatus",
            "text": "Exemption status",
            "answerOption": [
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "1",
                        "display": "Approved: Exemption from COVID vaccination"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "2",
                        "display": "Approved: Exemption from COVID vaccination and testing"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "3",
                        "display": "Rejected: Exemption from COVID vaccination"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "4",
                        "display": "Rejected: Exemption from COVID vaccination and testing"
                    }
                }
            ]```

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-9: Read-only can't be specified for "display" items
type!='display' or readOnly.empty()
que-8: Initial values can't be specified for groups or display items
(type!='group' and type!='display') or initial.empty()
que-6: Required and repeat aren't permitted for display items
type!='display' or (required.empty() and repeats.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-4: A question cannot have both answerOption and answerValueSet
answerOption.empty() or answerValueSet.empty()
que-3: Display items cannot have a "code" asserted
type!='display' or code.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-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-13: Can only have multiple initial values for repeating items
repeats=true or initial.count() <= 1
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()

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

linkId

1..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.linkId

Short description

Unique id for item in questionnaire

Definition

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .id

definition

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.item.definition

Short description

ElementDefinition - details for the item

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

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]

code

0..*

Coding

There are no (further) constraints on this element

Element id

Questionnaire.item.code

Short description

Corresponding concept for this item in a terminology

Definition

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

Requirements

Allows linking of groups of questions to formal terminologies.

Comments

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

Data type

Coding

Binding

Codes for questionnaires, groups and individual questions.

QuestionnaireQuestionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-3

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
rim: .code

prefix

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.prefix

Short description

E.g. "1(a)", "2.5.3"

Alternate names

label

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.

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: Not supported

text

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.text

Short description

Primary text for the item

Definition

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .text

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.type

Short description

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

Requirements

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

Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Data type

code

Binding

Distinguishes groups from questions and display text and indicates data type for questions.

QuestionnaireItemType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

enableWhen

?! C

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen

Short description

Only allow data when

Definition

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

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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)

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

question

1..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.question

Short description

Question that determines whether item is enabled

Definition

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

operator

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.operator

Short description

exists | = | != | > | < | >= | <=

Definition

Specifies the criteria by which the question is enabled.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The criteria by which a question is enabled.

QuestionnaireItemOperator (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answer[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.answer[x]

Short description

Value for question comparison based on operator

Definition

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-7

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answerBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

answerCoding

Coding

There are no (further) constraints on this element

Data type

Coding

answerDate

date

There are no (further) constraints on this element

Data type

date

answerDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

answerDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

answerInteger

integer

There are no (further) constraints on this element

Data type

integer

answerQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

answerReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

answerString

string

There are no (further) constraints on this element

Data type

string

answerTime

time

There are no (further) constraints on this element

Data type

time

enableBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableBehavior

Short description

all | any

Definition

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

Comments

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

Data type

code

Binding

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

EnableWhenBehavior (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-12

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

required

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.required

Short description

Whether the item must be included in data results

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.

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 when missing

Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-6

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

repeats

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.repeats

Short description

Whether the item may repeat

Definition

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

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 when missing

Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-6

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

readOnly

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.readOnly

Short description

Don't allow human editing

Definition

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

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-9

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

maxLength

0..1

integer

There are no (further) constraints on this element

Element id

Questionnaire.item.maxLength

Short description

No more than this many characters

Definition

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

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.

Data type

integer

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-10

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: N/A - MIF rather than RIM level

answerValueSet

0..1

canonical(ValueSet)

There are no (further) constraints on this element

Element id

Questionnaire.item.answerValueSet

Short description

Valueset containing permitted answers

Definition

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

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.

Data type

canonical(ValueSet)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answerOption

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption

Short description

Permitted answer

Definition

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

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.value[x]

Short description

Answer value

Definition

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

Comments

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueDate

date

There are no (further) constraints on this element

Data type

date

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

initialSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.initialSelected

Short description

Whether option is selected by default

Definition

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

Comments

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

Meaning when missing

Only selected items explicitly marked to be selected

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

initial

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.initial

Short description

Initial value(s) when item is first rendered

Definition

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

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-8, que-13

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.value[x]

Short description

Actual value for initializing the question

Definition

The actual value to for an initial answer.

Comments

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueUri

uri

There are no (further) constraints on this element

Data type

uri

item

0..*

see (item)

There are no (further) constraints on this element

Element id

Questionnaire.item.item

Short description

Nested questionnaire items

Definition

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

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.

Conditions

The cardinality or value of this element may be affected by these constraints: que-1

Mappings

rim: .outboundRelationship[typeCode=COMP].target

from Questionnaire

NHSDigitalQuestionnaire (Questionnaire)

There are no (further) constraints on this element

Element id

Questionnaire

Short description

A structured set of questions

Alternate names

Form, CRF, Survey

Definition

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
que-2: The link ids for groups and questions must be unique within the questionnaire
descendants().linkId.isDistinct()
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Mappings

rim: Entity. Role, or Act
workflow: Definition
rim: Observation[moodCode=DEF]

0..1

There are no (further) constraints on this element

Element id

Questionnaire.id

Short description

Logical id of this artifact

Definition

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

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

Questionnaire.meta

Short description

Metadata about the resource

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Questionnaire.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Questionnaire.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

url

S Σ

0..1

uri

Element id

Questionnaire.url

Short description

Canonical identifier for this questionnaire, represented as a URI (globally unique)

Definition

   "url": "https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption",

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.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.url
w5: FiveWs.identifier
rim: .identifier[scope=BUSN;reliability=ISS]

identifier

0..*

Identifier

There are no (further) constraints on this element

Element id

Questionnaire.identifier

Short description

Additional identifier for the questionnaire

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.

Requirements

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

Comments

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Definition.identifier
w5: FiveWs.identifier
rim: .identifier
objimpl: no-gen-base

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Questionnaire.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference()

There are no (further) constraints on this element

Element id

Questionnaire.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference()

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

version

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.version

Short description

Business version of the questionnaire

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.version
w5: FiveWs.version
rim: N/A (to add?)

name

Σ C

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.name

Short description

Name for this questionnaire (computer friendly)

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-0

Constraints

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

Mappings

rim: n/a
rim: N/A

title

S Σ

0..1

string

Element id

Questionnaire.title

Short description

Name for this questionnaire (human friendly)

Definition

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

 "title": "COVID Vaccinnation Medical Exemption",

Comments

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

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.title
rim: .title

derivedFrom

0..*

canonical()

There are no (further) constraints on this element

Element id

Questionnaire.derivedFrom

Short description

Instantiates protocol or definition

Definition

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

Requirements

Allows a Questionnaire to be created based on another Questionnaire.

Comments

see Canonical References

Data type

canonical()

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.derivedFrom
rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]

status

S Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.status

Short description

draft | active | retired | unknown

Definition

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

Comments

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

Data type

code

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.status
w5: FiveWs.status
rim: .status

experimental

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.experimental

Short description

For testing purposes, not real usage

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.

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.experimental
w5: FiveWs.class
rim: N/A

subjectType

S Σ

0..*

codeBinding

Element id

Questionnaire.subjectType

Short description

Resource that can be subject of QuestionnaireResponse

Definition

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

 "subjectType": [
        "Patient"
    ],

Comments

If none are specified, then the subject is unlimited.

Data type

code

Binding

One of the resource types defined as part of this version of FHIR.

ResourceType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.subject[x]
rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode

date

0..1

dateTime

There are no (further) constraints on this element

Element id

Questionnaire.date

Short description

Date last changed

Alternate names

Revision Date

Definition

Comments

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.date
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

publisher

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.publisher

Short description

Name of the publisher (organization or individual)

Definition

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

Requirements

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

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.publisher
w5: FiveWs.witness
rim: .participation[typeCode=AUT].role

contact

0..*

ContactDetail

There are no (further) constraints on this element

Element id

Questionnaire.contact

Short description

Contact details for the publisher

Definition

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

Comments

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

Data type

ContactDetail

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.contact
rim: .participation[typeCode=CALLBCK].role

description

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.description

Short description

Natural language description of the questionnaire

Definition

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

Comments

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.description
rim: .text

useContext

0..*

UsageContext

There are no (further) constraints on this element

Element id

Questionnaire.useContext

Short description

The context that the content is intended to support

Definition

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.

Data type

UsageContext

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.useContext
rim: N/A (to add?)

jurisdiction

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Questionnaire.jurisdiction

Short description

Intended jurisdiction for questionnaire (if applicable)

Definition

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

Comments

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

Data type

CodeableConcept

Binding

Countries and regions within which this artifact is targeted for use.

Jurisdiction ValueSet (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Definition.jurisdiction
rim: N/A (to add?)

purpose

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.purpose

Short description

Why this questionnaire is defined

Definition

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

Comments

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.purpose
w5: FiveWs.why[x]
rim: .reasonCode.text
objimpl: no-gen-base

0..1

markdown

There are no (further) constraints on this element

Element id

Questionnaire.copyright

Short description

Use and/or publishing restrictions

Alternate names

License, Restrictions

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.

Requirements

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

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.copyright
rim: N/A (to add?)
objimpl: no-gen-base

approvalDate

0..1

date

There are no (further) constraints on this element

Element id

Questionnaire.approvalDate

Short description

When the questionnaire was approved by publisher

Definition

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

Comments

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

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.approvalDate
rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
objimpl: no-gen-base

lastReviewDate

0..1

date

There are no (further) constraints on this element

Element id

Questionnaire.lastReviewDate

Short description

When the questionnaire was last reviewed

Definition

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

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.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Definition.lastReviewDate
rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
objimpl: no-gen-base

effectivePeriod

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Questionnaire.effectivePeriod

Short description

When the questionnaire is expected to be used

Definition

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

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

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Definition.effectivePeriod
rim: N/A (to add?)
objimpl: no-gen-base

code

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Questionnaire.code

Short description

Concept that represents the overall questionnaire

Definition

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

Requirements

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

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Data type

Coding

Binding

(preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
rim: .code

item

S C

1..*

BackboneElement

Element id

Questionnaire.item

Short description

Questions and sections within the Questionnaire

Definition

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

Comments

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

"item": [
        {
            "type": "choice",
            "required": true,
            "linkId": "exemptionStatus",
            "text": "Exemption status",
            "answerOption": [
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "1",
                        "display": "Approved: Exemption from COVID vaccination"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "2",
                        "display": "Approved: Exemption from COVID vaccination and testing"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "3",
                        "display": "Rejected: Exemption from COVID vaccination"
                    }
                },
                {
                    "valueCoding": {
                        "system": "https://fhir.nhs.uk/CodeSystem/covid-vaccination-medical-exemption",
                        "code": "4",
                        "display": "Rejected: Exemption from COVID vaccination and testing"
                    }
                }
            ]```

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
que-9: Read-only can't be specified for "display" items
type!='display' or readOnly.empty()
que-8: Initial values can't be specified for groups or display items
(type!='group' and type!='display') or initial.empty()
que-6: Required and repeat aren't permitted for display items
type!='display' or (required.empty() and repeats.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-4: A question cannot have both answerOption and answerValueSet
answerOption.empty() or answerValueSet.empty()
que-3: Display items cannot have a "code" asserted
type!='display' or code.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-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-13: Can only have multiple initial values for repeating items
repeats=true or initial.count() <= 1
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()

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

linkId

1..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.linkId

Short description

Unique id for item in questionnaire

Definition

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .id

definition

0..1

uri

There are no (further) constraints on this element

Element id

Questionnaire.item.definition

Short description

ElementDefinition - details for the item

Definition

code (ElementDefinition.code)
type (ElementDefinition.type)
required (ElementDefinition.min)
repeats (ElementDefinition.max)
maxLength (ElementDefinition.maxLength)
answerValueSet (ElementDefinition.binding)
options (ElementDefinition.binding).

Requirements

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]

code

0..*

Coding

There are no (further) constraints on this element

Element id

Questionnaire.item.code

Short description

Corresponding concept for this item in a terminology

Definition

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

Requirements

Allows linking of groups of questions to formal terminologies.

Comments

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

Data type

Coding

Binding

Codes for questionnaires, groups and individual questions.

QuestionnaireQuestionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-3

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
rim: .code

prefix

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.prefix

Short description

E.g. "1(a)", "2.5.3"

Alternate names

label

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.

Requirements

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: Not supported

text

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.text

Short description

Primary text for the item

Definition

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

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .text

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.type

Short description

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

Requirements

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

Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Data type

code

Binding

Distinguishes groups from questions and display text and indicates data type for questions.

QuestionnaireItemType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

enableWhen

?! C

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen

Short description

Only allow data when

Definition

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

Requirements

Comments

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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)

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

question

1..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.question

Short description

Question that determines whether item is enabled

Definition

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

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

operator

1..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.operator

Short description

exists | = | != | > | < | >= | <=

Definition

Specifies the criteria by which the question is enabled.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The criteria by which a question is enabled.

QuestionnaireItemOperator (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answer[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.enableWhen.answer[x]

Short description

Value for question comparison based on operator

Definition

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-7

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answerBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

answerCoding

Coding

There are no (further) constraints on this element

Data type

Coding

answerDate

date

There are no (further) constraints on this element

Data type

date

answerDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

answerDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

answerInteger

integer

There are no (further) constraints on this element

Data type

integer

answerQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

answerReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

answerString

string

There are no (further) constraints on this element

Data type

string

answerTime

time

There are no (further) constraints on this element

Data type

time

enableBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

Questionnaire.item.enableBehavior

Short description

all | any

Definition

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

Comments

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

Data type

code

Binding

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

EnableWhenBehavior (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-12

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

required

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.required

Short description

Whether the item must be included in data results

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.

Comments

Meaning when missing

Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-6

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

repeats

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.repeats

Short description

Whether the item may repeat

Definition

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

Requirements

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

Comments

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 when missing

Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-6

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

readOnly

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.readOnly

Short description

Don't allow human editing

Definition

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

Requirements

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-9

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

maxLength

0..1

integer

There are no (further) constraints on this element

Element id

Questionnaire.item.maxLength

Short description

No more than this many characters

Definition

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

Comments

Data type

integer

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-10

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: N/A - MIF rather than RIM level

answerValueSet

0..1

canonical(ValueSet)

There are no (further) constraints on this element

Element id

Questionnaire.item.answerValueSet

Short description

Valueset containing permitted answers

Definition

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

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.

Data type

canonical(ValueSet)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

answerOption

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption

Short description

Permitted answer

Definition

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

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.value[x]

Short description

Answer value

Definition

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

Comments

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueDate

date

There are no (further) constraints on this element

Data type

date

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

initialSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Questionnaire.item.answerOption.initialSelected

Short description

Whether option is selected by default

Definition

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

Comments

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

Meaning when missing

Only selected items explicitly marked to be selected

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

initial

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Questionnaire.item.initial

Short description

Initial value(s) when item is first rendered

Definition

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

Requirements

In some workflows, having defaults saves time.

Comments

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, que-8, que-13

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

0..1

string

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

value[x]

1..1

There are no (further) constraints on this element

Element id

Questionnaire.item.initial.value[x]

Short description

Actual value for initializing the question

Definition

The actual value to for an initial answer.

Comments

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

Binding

Allowed values to answer questions.

QuestionnaireAnswerCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A - MIF rather than RIM level

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueReference

Reference(Resource)

There are no (further) constraints on this element

Data type

Reference(Resource)

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueUri

uri

There are no (further) constraints on this element

Data type

uri

item

0..*

see (item)

There are no (further) constraints on this element

Element id

Questionnaire.item.item

Short description

Nested questionnaire items

Definition

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

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.

Conditions

The cardinality or value of this element may be affected by these constraints: que-1

Mappings

rim: .outboundRelationship[typeCode=COMP].target

COVID19VaccinationMedicalExemption