Response to Regulatory Questions (RTQ)
0.1.0 - ci-build
Response to Regulatory Questions (RTQ), published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/rtq-ig/ and changes regularly. See the Directory of published versions
| Draft as of 2025-11-21 |
Definitions for the rtq-questionnaire resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Questionnaire | |
| 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. |
| Short | A structured set of questions |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Form, CRF, Survey |
| Invariants | cnl-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_]){1,254}$')) que-2: The link ids for groups and questions must be unique within the questionnaire (descendants().linkId.isDistinct()) |
| 2. Questionnaire.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 10..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Questionnaire.meta.versionId | |
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
| Short | Version specific identifier |
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
| Control | 10..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Questionnaire.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| Control | 10..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Questionnaire.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| Control | 10..1* |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Fixed Value | http://hl7.org/fhir/uv/rtq/StructureDefinition/rtq-questionnaire |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Questionnaire.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Questionnaire.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 10..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Questionnaire.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 16. Questionnaire.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 18. Questionnaire.identifier | |
| Definition | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..2* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 20. Questionnaire.identifier:company | |
| Slice Name | company |
| 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. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Questionnaire.identifier:company.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Questionnaire.identifier:company.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 10..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Questionnaire.identifier:company.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..1* |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Fixed Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. Questionnaire.identifier:regulator | |
| Slice Name | regulator |
| 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. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Questionnaire.identifier:regulator.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Questionnaire.identifier:regulator.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 10..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Questionnaire.identifier:regulator.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..1* |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Fixed Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Questionnaire.version | |
| Definition | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
| Short | Business version of the questionnaire |
| Comments | There may be different questionnaires that have the same url 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. The version SHOULD NOT contain a '#' - see Business Version. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 10..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. Questionnaire.status | |
| Definition | The current state of this questionnaire. |
| Short | draft | active | retired | unknown |
| Comments | A nominal state-transition diagram can be found in the] documentation Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. A nominal state-transition diagram can be found in the] documentation Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. |
| Control | 1..1 This element is affected by the following invariants: que-1a |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Enables tracking the lifecycle of the content and filtering of questionnaires that are appropriate for use versus not. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Questionnaire.subjectType | |
| Definition | The types of subjects that can be the subject of responses created for the questionnaire. |
| Short | Resource that can be subject of QuestionnaireResponse |
| Comments | If none are specified, then the subject is unlimited. |
| Control | 10..* |
| Binding | Unless not suitable, these codes SHALL be taken from The codes SHALL be taken from http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vshttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vs) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Questionnaire.publisher | |
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire. |
| Short | Name of the publisher/steward (organization or individual) |
| 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. |
| Control | 0..01 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Questionnaire.contact | |
| Definition | Exactly two contacts shall be present: one identifying the competent authority that issued the Request to Qualify Questionnaire (sender) and one identifying the marketing authorisation holder or applicant that is required to complete and return the QuestionnaireResponse (receiver). Slicing is based on organization.name to distinguish the two parties. Contact details to assist a user in finding and communicating with the publisher. |
| Short | Sender (issuing regulatory authority) and receiver (MAH/applicant) contact detailsContact details for the publisher |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 20..2* |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Questionnaire.contact. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 46. Questionnaire.contact:sender | |
| Slice Name | sender |
| Definition | Identifies the regulatory authority or agency that has created and sent this Questionnaire to the marketing authorisation holder. Contact details to assist a user in finding and communicating with the publisher. |
| Short | Contact details of the issuing competent authority (regulator)Contact details for the publisher |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 10..1* |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Questionnaire.contact:receiver | |
| Slice Name | receiver |
| Definition | Identifies the pharmaceutical company, marketing authorisation holder, submitter or applicant that is the recipient of this Questionnaire and is obliged to provide the completed response. Contact details to assist a user in finding and communicating with the publisher. |
| Short | Contact details of the marketing authorisation holder/applicantContact details for the publisher |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 10..1* |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. Questionnaire.item | |
| Definition | A particular question, question grouping or display text that is part of the questionnaire. |
| Short | Question in the regulatory questionnaireQuestions and sections within the Questionnaire |
| Comments | The content of the questionnaire is constructed from an ordered, hierarchical collection of items. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) que-1a: Group items must have nested items when Questionanire is complete ((type='group' and %resource.status='complete') implies item.empty().not()) que-1b: Groups should have items (type='group' implies item.empty().not()) que-1c: Display items cannot have child items (type='display' implies item.empty()) que-3: Display items cannot have a "code" asserted (type!='display' or code.empty()) que-4: A question cannot have both answerOption and answerValueSet (answerOption.empty() or answerValueSet.empty()) que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet ((type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())) que-6: Required and repeat aren't permitted for display items (type!='display' or (required.empty() and repeats.empty())) que-8: Initial values can't be specified for groups or display items ((type!='group' and type!='display') or initial.empty()) que-9: Read-only can't be specified for "display" items (type!='display' or readOnly.empty()) que-10: Maximum length can only be declared for simple question types ((type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty()) que-11: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead (answerOption.empty() or initial.empty()) que-12: If there are more than one enableWhen, enableBehavior must be specified (enableWhen.count() > 1 implies enableBehavior.exists()) que-13: Can only have multiple initial values for repeating items (repeats=true or initial.count() <= 1) que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) (answerConstraint.exists() implies answerOption.exists() or answerValueSet.exists()) |
| 52. Questionnaire.item.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 54. Questionnaire.item.linkId | |
| Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
| Short | Unique id for item in questionnaire |
| 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. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such |
| Control | 1..1 This element is affected by the following invariants: que-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| 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. 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) que-15: Link ids should be 255 characters or less ($this.length() <= 255) |
| 56. Questionnaire.item.code | |
| Definition | A required code from the RTQ CTD Categories CodeSystem (or an allowed extension of it) that identifies which section, subsection, or specific regulatory topic within a medicinal product dossier this questionnaire item pertains to. This enables precise mapping and automated routing in regulatory processes. A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). |
| Short | CTD-based category code that classifies the regulatory topic of this question/groupCorresponding concept for this item in a terminology |
| Comments | Examples: '2-3-s-4-2' = Nonclinical Overview, '3-2-p-5-3' = Microbiological quality control, etc. The value may come from the ElementDefinition referred to by .definition. |
| Control | 10..* This element is affected by the following invariants: que-3 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-fullhttp://hl7.org/fhir/ValueSet/questionnaire-questions|5.0.0 (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-full)Codes from the full CTD hierarchy as defined in the RTQ CTD Categories CodeSystem. Additional codes beyond the standard CTD structure may be defined locally or in future versions of the CodeSystem when new regulatory topics are required. Codes for questionnaires, groups and individual questions. |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Requirements | Allows linking of groups of questions to formal terminologies. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Questionnaire.item.code.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Fixed Value | http://hl7.org/fhir/uv/rtq/CodeSystem/ctd-categories-full |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. Questionnaire.item.code.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | CTD section/subsection code (e.g., 2-3-s-4-2-1)Symbol in syntax defined by the system |
| Control | 10..1 This element is affected by the following invariants: cod-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Questionnaire.item.code.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Human-readable title of the CTD categoryRepresentation defined by the system |
| Control | 10..1 This element is affected by the following invariants: cod-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Questionnaire.item.text | |
| Definition | The name of a section, the text of a question or text content for a display item. |
| Short | Primary text for the 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. |
| Control | 10..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Questionnaire.item.text.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 10..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.item.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Questionnaire.item.text.extension:rendering-xhtml | |
| Slice Name | rendering-xhtml |
| Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display. |
| Short | String equivalent with html markup |
| Comments | For questionnaires, see additional guidance and examples in the SDC implementation guide. |
| Control | 1..1 |
| Type | Extension(XHTML Representation) (Extension Type: string) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | 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()) |
| 70. Questionnaire.item.type | |
| Definition | The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.). |
| Short | group | display | boolean | decimal | integer | date | dateTime + |
| Comments | Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. |
| Control | 1..1 This element is affected by the following invariants: que-9, que-8, que-6, que-5, que-3, que-10, que-1a, que-1b, que-1c |
| Binding | The codes SHALL be taken from QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|5.0.0 (required to http://hl7.org/fhir/ValueSet/item-type|5.0.0)Distinguishes groups from questions and display text and indicates data type for questions. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Defines the format in which the user is to be prompted for the answer. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Questionnaire.item.enableWhen | |
| Definition | A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. |
| Short | Only allow data when |
| Comments | If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if any of the answers for the referenced item match the enableWhen condition. 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. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form is displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc. |
| Control | 0..* This element is affected by the following invariants: que-12 |
| Type | BackboneElement |
| Is Modifier | true because If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | 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)) |
| 74. Questionnaire.item.enableWhen.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 76. Questionnaire.item.enableWhen.question | |
| Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
| Short | The linkId of question that determines whether item is enabled/disabled |
| 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. If there are multiple items with the same linkId and all are equadistant (e.g. a question references a question that appears in a separate repeating group), that is an error. (Consider using the enableWhenExpression extension to define logic to handle such a situation.) |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. Questionnaire.item.enableWhen.operator | |
| Definition | Specifies the criteria by which the question is enabled. |
| Short | exists | = | != | > | < | >= | <= |
| Control | 1..1 This element is affected by the following invariants: que-7 |
| Binding | The codes SHALL be taken from QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0 (required to http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0)The criteria by which a question is enabled. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Questionnaire.item.enableWhen.answer[x] | |
| Definition | A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension. |
| Short | Value for question comparison based on operator |
| Control | 1..1 This element is affected by the following invariants: que-7 |
| Binding | For example codes, see QuestionnaireAnswerCodeshttp://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0 (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Questionnaire.item.repeats | |
| Definition | An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items). |
| Short | Whether the item may repeat |
| 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. When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
| Control | 0..1 This element is affected by the following invariants: que-6, que-13 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
| Meaning if Missing | Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. Questionnaire.item.answerConstraint | |
| Definition | For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values other than those specified can be selected. |
| Short | optionsOnly | optionsOrType | optionsOrString |
| Control | 0..1 This element is affected by the following invariants: que-10, que-14 |
| Binding | The codes SHALL be taken from QuestionnaireAnswerConstrainthttp://hl7.org/fhir/ValueSet/questionnaire-answer-constraint|5.0.0 (required to http://hl7.org/fhir/ValueSet/questionnaire-answer-constraint|5.0.0)Indicates differnt modes for restricting values when options or valueset are specified |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Introduces the ability for questions to have 'other' answers |
| Meaning if Missing | If not specified, answerConstraint is presumed to be 'optionsOnly' |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Questionnaire.item.answerValueSet | |
| Definition | A reference to a value set containing a list of values representing permitted answers for a question. |
| Short | ValueSet containing permitted answers |
| 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. |
| Control | 0..1 This element is affected by the following invariants: que-5, que-4, que-14 |
| Type | canonical(ValueSet) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Questionnaire.item.answerOption | |
| Definition | One of the permitted answers for the question. |
| Short | Permitted answer |
| 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. |
| Control | 0..* This element is affected by the following invariants: que-5, que-4, que-11, que-14 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. Questionnaire.item.answerOption.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 92. Questionnaire.item.answerOption.value[x] | |
| Definition | A potential answer that's allowed as the answer to this question. |
| Short | Answer value |
| Comments | The data type of the value must agree with the item.type. |
| Control | 1..1 |
| Binding | For example codes, see QuestionnaireAnswerCodeshttp://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0 (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: integer, date, time, string, Coding, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Questionnaire.item.initial | |
| Definition | One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. |
| Short | Initial value(s) when item is first rendered |
| 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.answer[x] must agree with the item.type, and only repeating items can have more then one initial value. |
| Control | 0..* This element is affected by the following invariants: que-8, que-13, que-11 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | In some workflows, having defaults saves time. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Questionnaire.item.initial.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 98. Questionnaire.item.initial.value[x] | |
| Definition | The actual value to for an initial answer. |
| Short | Actual value for initializing the question |
| Comments | The type of the initial value must be consistent with the type of the item. |
| Control | 1..1 |
| Binding | For example codes, see QuestionnaireAnswerCodeshttp://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0 (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Questionnaire | |
| 2. Questionnaire.meta | |
| Control | 1..? |
| Must Support | true |
| 4. Questionnaire.meta.versionId | |
| Control | 1..? |
| Must Support | true |
| 6. Questionnaire.meta.lastUpdated | |
| Control | 1..? |
| Must Support | true |
| 8. Questionnaire.meta.profile | |
| Control | 1..1 |
| Must Support | true |
| Fixed Value | http://hl7.org/fhir/uv/rtq/StructureDefinition/rtq-questionnaire |
| 10. Questionnaire.text | |
| Control | 1..? |
| Must Support | true |
| 12. Questionnaire.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..2 |
| Must Support | true |
| Slicing | This element introduces a set of slices on Questionnaire.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 14. Questionnaire.identifier:company | |
| Slice Name | company |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Must Support | true |
| 16. Questionnaire.identifier:company.type | |
| Control | 1..? |
| Must Support | true |
| 18. Questionnaire.identifier:company.type.coding | |
| Control | 1..1 |
| Fixed Value | { |
| 20. Questionnaire.identifier:regulator | |
| Slice Name | regulator |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Must Support | true |
| 22. Questionnaire.identifier:regulator.type | |
| Control | 1..? |
| Must Support | true |
| 24. Questionnaire.identifier:regulator.type.coding | |
| Control | 1..1 |
| Fixed Value | { |
| 26. Questionnaire.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..? |
| Must Support | true |
| 28. Questionnaire.subjectType | |
| Control | 1..? |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vs (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vs) |
| Must Support | true |
| 30. Questionnaire.publisher | |
| Control | 0..0 |
| 32. Questionnaire.contact | |
| Definition | Exactly two contacts shall be present: one identifying the competent authority that issued the Request to Qualify Questionnaire (sender) and one identifying the marketing authorisation holder or applicant that is required to complete and return the QuestionnaireResponse (receiver). Slicing is based on organization.name to distinguish the two parties. |
| Short | Sender (issuing regulatory authority) and receiver (MAH/applicant) contact details |
| Control | 2..2 |
| Must Support | true |
| Slicing | This element introduces a set of slices on Questionnaire.contact. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 34. Questionnaire.contact:sender | |
| Slice Name | sender |
| Definition | Identifies the regulatory authority or agency that has created and sent this Questionnaire to the marketing authorisation holder. |
| Short | Contact details of the issuing competent authority (regulator) |
| Control | 1..1 |
| Must Support | true |
| 36. Questionnaire.contact:sender.organization | |
| Definition | The regulatory agency (e.g., EMA, national competent authority) responsible for issuing Questionnaire. |
| Short | Issuing competent authority |
| Control | 1..? |
| Must Support | true |
| 38. Questionnaire.contact:sender.organization.identifier | |
| Definition | Official identifier of the issuing competent authority. |
| Short | Regulatory authority identifier (e.g., OMS Location ID) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| 40. Questionnaire.contact:sender.organization.name | |
| Definition | Full official name of the competent authority issuing the Questionnaire (e.g., European Medicines Agency). |
| Short | Official name of the issuing regulatory authority |
| Control | 1..? |
| Must Support | true |
| 42. Questionnaire.contact:sender.organization.address | |
| Definition | Complete official address of the regulatory authority that issued the Questionnaire. |
| Short | Official address of the issuing competent authority |
| Control | 1..1 |
| Must Support | true |
| 44. Questionnaire.contact:sender.organization.address.text | |
| Definition | Complete address of the competent authority as a single human-readable string (for display and verification purposes). |
| Short | Full formatted address of the issuing authority |
| Control | 1..? |
| Must Support | true |
| 46. Questionnaire.contact:sender.organization.address.line | |
| Definition | Street address (including building, floor, department, P.O. Box, etc.) of the regulatory authority. |
| Short | Street address lines of the issuing authority |
| Control | 1..* |
| Must Support | true |
| 48. Questionnaire.contact:sender.organization.address.city | |
| Definition | City or municipality where the regulatory authority is located. |
| Short | City of the issuing competent authority |
| Control | 1..? |
| Must Support | true |
| 50. Questionnaire.contact:sender.organization.address.district | |
| Definition | District or borough within the city (if applicable). |
| Short | District (sub-division of city) of the issuing authority |
| Control | 0..? |
| Must Support | true |
| 52. Questionnaire.contact:sender.organization.address.state | |
| Definition | State, province, canton or equivalent administrative region of the regulatory authority (required when applicable, e.g., for national agencies in federal countries). |
| Short | State, province or region of the issuing authority |
| Control | 0..? |
| Must Support | true |
| 54. Questionnaire.contact:sender.organization.address.postalCode | |
| Definition | Postal or ZIP code of the regulatory authority’s address. |
| Short | Postal code of the issuing authority |
| Control | 1..? |
| Must Support | true |
| 56. Questionnaire.contact:sender.organization.address.country | |
| Definition | ISO 3166-1 alpha-2 country code of the country in which the regulatory authority is established (e.g., 'NL' for Netherlands, 'GB' for United Kingdom). |
| Short | Country of the issuing competent authority |
| Control | 1..? |
| Must Support | true |
| 58. Questionnaire.contact:sender.organization.contact | |
| Definition | Designated contact person or role within the regulatory authority responsible for this Questionnaire and for receiving the completed response. |
| Short | Primary contact at the issuing authority |
| Control | 1..? |
| Must Support | true |
| 60. Questionnaire.contact:sender.organization.contact.telecom | |
| Control | 2..2 |
| Must Support | true |
| Slicing | This element introduces a set of slices on Questionnaire.contact.organization.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 62. Questionnaire.contact:sender.organization.contact.telecom:email | |
| Slice Name | |
| Definition | Official email for the designated regulatory contact |
| Short | Official email for the designated regulatory contact |
| Control | 1..1 |
| 64. Questionnaire.contact:sender.organization.contact.telecom:email.system | |
| Fixed Value | email |
| 66. Questionnaire.contact:sender.organization.contact.telecom:email.value | |
| Control | 1..? |
| 68. Questionnaire.contact:sender.organization.contact.telecom:phone | |
| Slice Name | phone |
| Definition | Telephone number for the responsible regulatory contact. |
| Short | Telephone number for the responsible regulatory contact |
| Control | 0..1 |
| 70. Questionnaire.contact:sender.organization.contact.telecom:phone.system | |
| Fixed Value | phone |
| 72. Questionnaire.contact:sender.organization.contact.telecom:phone.value | |
| Control | 1..? |
| 74. Questionnaire.contact:receiver | |
| Slice Name | receiver |
| Definition | Identifies the pharmaceutical company, marketing authorisation holder, submitter or applicant that is the recipient of this Questionnaire and is obliged to provide the completed response. |
| Short | Contact details of the marketing authorisation holder/applicant |
| Control | 1..1 |
| Must Support | true |
| 76. Questionnaire.contact:receiver.organization | |
| Definition | The legal entity (MAH or applicant) to whom the Questionnaire is addressed. |
| Short | Marketing authorisation holder / applicant organisation |
| Control | 1..? |
| Must Support | true |
| 78. Questionnaire.contact:receiver.organization.identifier | |
| Definition | Official identifier of the receiving organisation as registered in an authoritative system. |
| Short | Organisation identifier of the MAH/applicant (e.g., OMS Organization ID) |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| 80. Questionnaire.contact:receiver.organization.name | |
| Definition | Full legal name of the marketing authorisation holder or applicant. |
| Short | Legal name of the MAH/applicant |
| Control | 1..? |
| Must Support | true |
| 82. Questionnaire.contact:receiver.organization.address | |
| Definition | Complete official registered address of the MAH or sponsor organisation to whom the Questionnaire is addressed. |
| Short | Official registered address of the marketing authorisation holder/sponsor |
| Control | 1..1 |
| Must Support | true |
| 84. Questionnaire.contact:receiver.organization.address.text | |
| Definition | Complete address of the marketing authorisation holder or sponsor as a single formatted string for display, verification, and correspondence purposes. |
| Short | Full formatted address of the MAH/sponsor (human-readable) |
| Control | 1..? |
| Must Support | true |
| 86. Questionnaire.contact:receiver.organization.address.line | |
| Definition | One or more lines containing the street address, building name/number, floor, department, P.O. Box, etc., of the marketing authorisation holder or sponsor as registered in OMS or equivalent authoritative source. |
| Short | Street address lines of the MAH/sponsor |
| Control | 1..* |
| Must Support | true |
| 88. Questionnaire.contact:receiver.organization.address.city | |
| Definition | City or municipality in which the marketing authorisation holder or sponsor is legally registered. |
| Short | City of the MAH/sponsor registered address |
| Control | 1..? |
| Must Support | true |
| 90. Questionnaire.contact:receiver.organization.address.district | |
| Definition | District, borough or sub-division of the city in which the MAH/sponsor is located (used when relevant, e.g., in large metropolitan areas). |
| Short | District or borough (if applicable) |
| Control | 0..? |
| Must Support | true |
| 92. Questionnaire.contact:receiver.organization.address.state | |
| Definition | State, province, canton, or equivalent administrative region of the MAH/sponsor’s registered address (required when the country has such subdivisions). |
| Short | State, province or region of the MAH/sponsor |
| Control | 0..? |
| Must Support | true |
| 94. Questionnaire.contact:receiver.organization.address.postalCode | |
| Definition | Postal code or ZIP code of the marketing authorisation holder or sponsor’s registered address. |
| Control | 1..? |
| Must Support | true |
| 96. Questionnaire.contact:receiver.organization.address.country | |
| Definition | ISO 3166-1 alpha-2 country code of the country in which the marketing authorisation holder or sponsor is legally established (e.g., 'DE' for Germany, 'US' for United States). |
| Short | Country of the MAH/sponsor registered address |
| Control | 1..? |
| Must Support | true |
| 98. Questionnaire.contact:receiver.organization.contact | |
| Definition | Individual or role within the MAH/applicant responsible for completing and returning the response. |
| Short | Regulatory affairs contact person at the MAH/applicant |
| Control | 1..? |
| Must Support | true |
| 100. Questionnaire.contact:receiver.organization.contact.telecom | |
| Control | 2..2 |
| Must Support | true |
| Slicing | This element introduces a set of slices on Questionnaire.contact.organization.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 102. Questionnaire.contact:receiver.organization.contact.telecom:email | |
| Slice Name | |
| Definition | Email address of the person or team at the MAH/applicant responsible for regulatory correspondence related to this regulatory activity. |
| Short | Regulatory contact email of the MAH/applicant |
| Control | 1..1 |
| 104. Questionnaire.contact:receiver.organization.contact.telecom:email.system | |
| Fixed Value | email |
| 106. Questionnaire.contact:receiver.organization.contact.telecom:email.value | |
| Control | 1..? |
| 108. Questionnaire.contact:receiver.organization.contact.telecom:phone | |
| Slice Name | phone |
| Definition | Direct telephone number (with country code) of the regulatory contact person at the receiving organisation. |
| Short | Telephone number of the regulatory contact at the MAH/applicant |
| Control | 1..1 |
| 110. Questionnaire.contact:receiver.organization.contact.telecom:phone.system | |
| Fixed Value | phone |
| 112. Questionnaire.contact:receiver.organization.contact.telecom:phone.value | |
| Control | 1..? |
| 114. Questionnaire.item | |
| Short | Question in the regulatory questionnaire |
| Must Support | true |
| 116. Questionnaire.item.code | |
| Definition | A required code from the RTQ CTD Categories CodeSystem (or an allowed extension of it) that identifies which section, subsection, or specific regulatory topic within a medicinal product dossier this questionnaire item pertains to. This enables precise mapping and automated routing in regulatory processes. |
| Short | CTD-based category code that classifies the regulatory topic of this question/group |
| Comments | Examples: '2-3-s-4-2' = Nonclinical Overview, '3-2-p-5-3' = Microbiological quality control, etc. |
| Control | 1..* |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-full (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-full)Codes from the full CTD hierarchy as defined in the RTQ CTD Categories CodeSystem. Additional codes beyond the standard CTD structure may be defined locally or in future versions of the CodeSystem when new regulatory topics are required. |
| Must Support | true |
| 118. Questionnaire.item.code.system | |
| Control | 1..? |
| Must Support | true |
| Fixed Value | http://hl7.org/fhir/uv/rtq/CodeSystem/ctd-categories-full |
| 120. Questionnaire.item.code.code | |
| Short | CTD section/subsection code (e.g., 2-3-s-4-2-1) |
| Control | 1..? |
| Must Support | true |
| 122. Questionnaire.item.code.display | |
| Short | Human-readable title of the CTD category |
| Control | 1..? |
| Must Support | true |
| 124. Questionnaire.item.text | |
| Control | 1..? |
| Must Support | true |
| 126. Questionnaire.item.text.extension | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Questionnaire.item.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Questionnaire.item.text.extension:rendering-xhtml | |
| Slice Name | rendering-xhtml |
| Control | 1..1 |
| Type | Extension(XHTML Representation) (Extension Type: string) |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Questionnaire | |
| 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. |
| Short | A structured set of questions |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Form, CRF, Survey |
| Invariants | cnl-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_]){1,254}$'))que-2: The link ids for groups and questions must be unique within the questionnaire ( descendants().linkId.isDistinct()) |
| 2. Questionnaire.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. Questionnaire.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 1..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Questionnaire.meta.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 8. Questionnaire.meta.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Questionnaire.meta.versionId | |
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
| Short | Version specific identifier |
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
| Control | 1..1 |
| Type | id |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Questionnaire.meta.lastUpdated | |
| Definition | When the resource last changed - e.g. when the version changed. |
| Short | When the resource version last changed |
| Comments | This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
| Control | 1..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Questionnaire.meta.source | |
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
| Short | Identifies where the resource comes from |
| Comments | The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Questionnaire.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| Control | 1..1 |
| Type | canonical(StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Fixed Value | http://hl7.org/fhir/uv/rtq/StructureDefinition/rtq-questionnaire |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Questionnaire.meta.security | |
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
| Short | Security Labels applied to this resource |
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from AllSecurityLabels (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)Security Labels from the Healthcare Privacy and Security Classification System. |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Questionnaire.meta.tag | |
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
| Short | Tags applied to this resource |
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| Control | 0..* |
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|5.0.0)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Questionnaire.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Questionnaire.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Questionnaire.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Control | 1..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. Questionnaire.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline Resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 30. Questionnaire.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 32. Questionnaire.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 34. Questionnaire.url | |
| Definition | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which 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. |
| Short | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows the questionnaire to be referenced by a single globally unique identifier. This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. |
| Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) |
| 36. Questionnaire.identifier | |
| Definition | A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..2 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 38. Questionnaire.identifier:company | |
| Slice Name | company |
| 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. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Questionnaire.identifier:company.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 42. Questionnaire.identifier:company.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Questionnaire.identifier:company.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Questionnaire.identifier:company.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Questionnaire.identifier:company.type.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 50. Questionnaire.identifier:company.type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Questionnaire.identifier:company.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 1..1 |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Fixed Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Questionnaire.identifier:company.type.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Short | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Questionnaire.identifier:company.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Questionnaire.identifier:company.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. Questionnaire.identifier:company.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Questionnaire.identifier:company.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Questionnaire.identifier:regulator | |
| Slice Name | regulator |
| 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. |
| Short | Business identifier for questionnaire |
| 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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Questionnaire.identifier:regulator.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 68. Questionnaire.identifier:regulator.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 70. Questionnaire.identifier:regulator.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Questionnaire.identifier:regulator.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Questionnaire.identifier:regulator.type.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 76. Questionnaire.identifier:regulator.type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Questionnaire.identifier:regulator.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 1..1 |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Fixed Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Questionnaire.identifier:regulator.type.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Short | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Questionnaire.identifier:regulator.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. Questionnaire.identifier:regulator.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Questionnaire.identifier:regulator.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Questionnaire.identifier:regulator.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. Questionnaire.version | |
| Definition | The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
| Short | Business version of the questionnaire |
| Comments | There may be different questionnaires that have the same url 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. The version SHOULD NOT contain a '#' - see Business Version. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. Questionnaire.versionAlgorithm[x] | |
| Definition | Indicates the mechanism used to compare versions to determine which is more current. |
| Short | How to compare versions |
| Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0) |
| Type | Choice of: string, Coding |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Questionnaire.name | |
| Definition | A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short | Name for this questionnaire (computer friendly) |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly. |
| Control | 0..1 This element is affected by the following invariants: cnl-0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Supports code generation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Questionnaire.title | |
| Definition | A short, descriptive, user-friendly title for the questionnaire. |
| Short | Name for this questionnaire (human friendly) |
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. Questionnaire.derivedFrom | |
| Definition | The URL of a Questionnaire that this Questionnaire is based on. |
| Short | Based on Questionnaire |
| Comments | This element covers a broad range of relationships, from 'somewhat inspired by' to 'fully compliant with'. There is a standard extensionthat allows clearer differentiation between the specifics of the derivation relationship where this is needed - e.g. to determine substitutability and validation expectations - http://hl7.org/fhir/StructureDefinition/questionnaire-derivationType. |
| Control | 0..* |
| Type | canonical(Questionnaire) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Allows a Questionnaire to be created based on another Questionnaire. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. Questionnaire.status | |
| Definition | The current state of this questionnaire. |
| Short | draft | active | retired | unknown |
| Comments | A nominal state-transition diagram can be found in the] documentation Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. |
| Control | 1..1 This element is affected by the following invariants: que-1a |
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)The lifecycle status of an artifact. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Enables tracking the lifecycle of the content and filtering of questionnaires that are appropriate for use versus not. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 102. Questionnaire.experimental | |
| Definition | A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. |
| Short | For testing purposes, not real usage |
| Comments | Allows filtering of questionnaires that are appropriate for use versus not. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. |
| Meaning if Missing | If absent, this resource is treated as though it is not experimental. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. Questionnaire.subjectType | |
| Definition | The types of subjects that can be the subject of responses created for the questionnaire. |
| Short | Resource that can be subject of QuestionnaireResponse |
| Comments | If none are specified, then the subject is unlimited. |
| Control | 1..* |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vs (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/rtq-questionnaire-type-vs) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. Questionnaire.date | |
| Definition | The date (and optionally time) when the questionnaire was last significantly changed. 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. |
| Short | Date last changed |
| Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | Revision Date |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. Questionnaire.publisher | |
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire. |
| Short | Name of the publisher/steward (organization or individual) |
| 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. |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. Questionnaire.contact | |
| Definition | Exactly two contacts shall be present: one identifying the competent authority that issued the Request to Qualify Questionnaire (sender) and one identifying the marketing authorisation holder or applicant that is required to complete and return the QuestionnaireResponse (receiver). Slicing is based on organization.name to distinguish the two parties. |
| Short | Sender (issuing regulatory authority) and receiver (MAH/applicant) contact details |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 2..2 |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Questionnaire.contact. The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
| 112. Questionnaire.contact:sender | |
| Slice Name | sender |
| Definition | Identifies the regulatory authority or agency that has created and sent this Questionnaire to the marketing authorisation holder. |
| Short | Contact details of the issuing competent authority (regulator) |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 1..1 |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. Questionnaire.contact:sender.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 116. Questionnaire.contact:sender.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 118. Questionnaire.contact:sender.name | |
| Definition | The name of an individual to contact. |
| Short | Name of an individual to contact |
| Comments | If there is no named individual, the telecom information is for the organization as a whole. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. Questionnaire.contact:sender.telecom | |
| Definition | The contact details for the individual (if a name was provided) or the organization. |
| Short | Contact details for individual or organization |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. Questionnaire.contact:receiver | |
| Slice Name | receiver |
| Definition | Identifies the pharmaceutical company, marketing authorisation holder, submitter or applicant that is the recipient of this Questionnaire and is obliged to provide the completed response. |
| Short | Contact details of the marketing authorisation holder/applicant |
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. |
| Control | 1..1 |
| Type | ContactDetail |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. Questionnaire.contact:receiver.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 126. Questionnaire.contact:receiver.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 128. Questionnaire.contact:receiver.name | |
| Definition | The name of an individual to contact. |
| Short | Name of an individual to contact |
| Comments | If there is no named individual, the telecom information is for the organization as a whole. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. Questionnaire.contact:receiver.telecom | |
| Definition | The contact details for the individual (if a name was provided) or the organization. |
| Short | Contact details for individual or organization |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 132. Questionnaire.description | |
| Definition | A free text natural language description of the questionnaire from a consumer's perspective. |
| Short | Natural language description of the questionnaire |
| Comments | This description can be used to capture details such as 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). |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 134. Questionnaire.useContext | |
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaires. |
| Short | The context that the content is intended to support |
| Comments | When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply. |
| Control | 0..* |
| Type | UsageContext |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Assist in searching for appropriate content. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. Questionnaire.jurisdiction | |
| Definition | A legal or geographic region in which the questionnaire is intended to be used. |
| Short | Intended jurisdiction for questionnaire (if applicable) |
| Comments | It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) |
| Control | 0..* |
| Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0)Countries and regions within which this artifact is targeted for use. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 138. Questionnaire.purpose | |
| Definition | Explanation of why this questionnaire is needed and why it has been designed as it has. |
| Short | Why this questionnaire is defined |
| 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. |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 140. Questionnaire.copyright | |
| Definition | A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. |
| Short | Use and/or publishing restrictions |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Consumers of the questionnaire must be able to determine any legal restrictions on the use of the artifact and/or its content. |
| Alternate Names | License, Restrictions |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. Questionnaire.copyrightLabel | |
| Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
| Short | Copyright holder and year(s) |
| Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Defines the content expected to be rendered in all representations of the artifact. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 144. Questionnaire.approvalDate | |
| Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
| Short | When the questionnaire was approved by publisher |
| Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 146. Questionnaire.lastReviewDate | |
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
| Short | When the questionnaire was last reviewed by the publisher |
| Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 148. Questionnaire.effectivePeriod | |
| Definition | The period during which the questionnaire content was or is planned to be in active use. |
| Short | When the questionnaire is expected to be used |
| 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 questionnaire intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. Questionnaire.code | |
| Definition | An identifier for this collection of questions in a particular terminology such as LOINC. |
| Short | Concept that represents the overall questionnaire |
| Control | 0..* |
| Binding | For example codes, see QuestionnaireQuestionCodes (example to http://hl7.org/fhir/ValueSet/questionnaire-questions|5.0.0)Codes for questionnaires, groups and individual questions. |
| Type | Coding |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 152. Questionnaire.item | |
| Definition | A particular question, question grouping or display text that is part of the questionnaire. |
| Short | Question in the regulatory questionnaire |
| Comments | The content of the questionnaire is constructed from an ordered, hierarchical collection of items. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))que-1a: Group items must have nested items when Questionanire is complete ( (type='group' and %resource.status='complete') implies item.empty().not())que-1b: Groups should have items ( type='group' implies item.empty().not())que-1c: Display items cannot have child items ( type='display' implies item.empty())que-3: Display items cannot have a "code" asserted ( type!='display' or code.empty())que-4: A question cannot have both answerOption and answerValueSet ( answerOption.empty() or answerValueSet.empty())que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet ( (type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()))que-6: Required and repeat aren't permitted for display items ( type!='display' or (required.empty() and repeats.empty()))que-8: Initial values can't be specified for groups or display items ( (type!='group' and type!='display') or initial.empty())que-9: Read-only can't be specified for "display" items ( type!='display' or readOnly.empty())que-10: Maximum length can only be declared for simple question types ( (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty())que-11: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead ( answerOption.empty() or initial.empty())que-12: If there are more than one enableWhen, enableBehavior must be specified ( enableWhen.count() > 1 implies enableBehavior.exists())que-13: Can only have multiple initial values for repeating items ( repeats=true or initial.count() <= 1)que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) ( answerConstraint.exists() implies answerOption.exists() or answerValueSet.exists()) |
| 154. Questionnaire.item.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 156. Questionnaire.item.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 158. Questionnaire.item.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 160. Questionnaire.item.linkId | |
| Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
| Short | Unique id for item in questionnaire |
| 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. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such |
| Control | 1..1 This element is affected by the following invariants: que-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))que-15: Link ids should be 255 characters or less ( $this.length() <= 255) |
| 162. Questionnaire.item.definition | |
| Definition | This element is a URI that refers to an ElementDefinition or to an ObservationDefinition 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. |
| Short | ElementDefinition - details for the item |
| Comments | The uri refers to an ElementDefinition in a StructureDefinition or to an ObservationDefinition 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 164. Questionnaire.item.code | |
| Definition | A required code from the RTQ CTD Categories CodeSystem (or an allowed extension of it) that identifies which section, subsection, or specific regulatory topic within a medicinal product dossier this questionnaire item pertains to. This enables precise mapping and automated routing in regulatory processes. |
| Short | CTD-based category code that classifies the regulatory topic of this question/group |
| Comments | Examples: '2-3-s-4-2' = Nonclinical Overview, '3-2-p-5-3' = Microbiological quality control, etc. |
| Control | 1..* This element is affected by the following invariants: que-3 |
| Binding | Unless not suitable, these codes SHALL be taken from http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-full (extensible to http://hl7.org/fhir/uv/rtq/ValueSet/ctd-categories-full)Codes from the full CTD hierarchy as defined in the RTQ CTD Categories CodeSystem. Additional codes beyond the standard CTD structure may be defined locally or in future versions of the CodeSystem when new regulatory topics are required. |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Requirements | Allows linking of groups of questions to formal terminologies. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. Questionnaire.item.code.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 168. Questionnaire.item.code.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.item.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 170. Questionnaire.item.code.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Fixed Value | http://hl7.org/fhir/uv/rtq/CodeSystem/ctd-categories-full |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 172. Questionnaire.item.code.version | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Short | Version of the system - if relevant |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 174. Questionnaire.item.code.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | CTD section/subsection code (e.g., 2-3-s-4-2-1) |
| Control | 1..1 This element is affected by the following invariants: cod-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 176. Questionnaire.item.code.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Human-readable title of the CTD category |
| Control | 1..1 This element is affected by the following invariants: cod-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 178. Questionnaire.item.code.userSelected | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Short | If this coding was chosen directly by the user |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 180. Questionnaire.item.prefix | |
| Definition | A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. |
| Short | E.g. "1(a)", "2.5.3" |
| 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. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used. |
| Alternate Names | label |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 182. Questionnaire.item.text | |
| Definition | The name of a section, the text of a question or text content for a display item. |
| Short | Primary text for the 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. |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 184. Questionnaire.item.text.id | |
| Definition | unique id for the element within a resource (for internal references) |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 186. Questionnaire.item.text.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on Questionnaire.item.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 188. Questionnaire.item.text.extension:rendering-xhtml | |
| Slice Name | rendering-xhtml |
| Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display. |
| Short | String equivalent with html markup |
| Comments | For questionnaires, see additional guidance and examples in the SDC implementation guide. |
| Control | 1..1 |
| Type | Extension(XHTML Representation) (Extension Type: string) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 190. Questionnaire.item.text.value | |
| Definition | The actual value |
| Short | Primitive value for string |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Max Length: | 1048576 |
| 192. Questionnaire.item.type | |
| Definition | The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.). |
| Short | group | display | boolean | decimal | integer | date | dateTime + |
| Comments | Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. |
| Control | 1..1 This element is affected by the following invariants: que-9, que-8, que-6, que-5, que-3, que-10, que-1a, que-1b, que-1c |
| Binding | The codes SHALL be taken from QuestionnaireItemType (required to http://hl7.org/fhir/ValueSet/item-type|5.0.0)Distinguishes groups from questions and display text and indicates data type for questions. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Defines the format in which the user is to be prompted for the answer. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 194. Questionnaire.item.enableWhen | |
| Definition | A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. |
| Short | Only allow data when |
| Comments | If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if any of the answers for the referenced item match the enableWhen condition. 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. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form is displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc. |
| Control | 0..* This element is affected by the following invariants: que-12 |
| Type | BackboneElement |
| Is Modifier | true because If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | 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)) |
| 196. Questionnaire.item.enableWhen.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 198. Questionnaire.item.enableWhen.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 200. Questionnaire.item.enableWhen.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 202. Questionnaire.item.enableWhen.question | |
| Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
| Short | The linkId of question that determines whether item is enabled/disabled |
| 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. If there are multiple items with the same linkId and all are equadistant (e.g. a question references a question that appears in a separate repeating group), that is an error. (Consider using the enableWhenExpression extension to define logic to handle such a situation.) |
| Control | 1..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 204. Questionnaire.item.enableWhen.operator | |
| Definition | Specifies the criteria by which the question is enabled. |
| Short | exists | = | != | > | < | >= | <= |
| Control | 1..1 This element is affected by the following invariants: que-7 |
| Binding | The codes SHALL be taken from QuestionnaireItemOperator (required to http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0)The criteria by which a question is enabled. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 206. Questionnaire.item.enableWhen.answer[x] | |
| Definition | A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension. |
| Short | Value for question comparison based on operator |
| Control | 1..1 This element is affected by the following invariants: que-7 |
| Binding | For example codes, see QuestionnaireAnswerCodes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 208. Questionnaire.item.enableBehavior | |
| Definition | Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| Short | all | any |
| Comments | This element must be specified if more than one enableWhen value is provided. |
| Control | 0..1 This element is affected by the following invariants: que-12 |
| Binding | The codes SHALL be taken from EnableWhenBehavior (required to http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|5.0.0)Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 210. Questionnaire.item.disabledDisplay | |
| Definition | Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed. |
| Short | hidden | protected |
| Comments | If not specified, rendering behavior is up to the client. This element is only meaningful if enableWhen or an equivalent extension is present |
| Control | 0..1 |
| Binding | The codes SHALL be taken from QuestionnaireItemDisabledDisplay (required to http://hl7.org/fhir/ValueSet/questionnaire-disabled-display|5.0.0)Defines how disabled elements should be rendered |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 212. Questionnaire.item.required | |
| Definition | An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. |
| Short | Whether the item must be included in data results |
| Comments | If the required item is a question, it must have a direct answer (i.e. an answer to the question itself, not merely answers to child questions) in order for the QuestionnaireResponse to be complete. If the required item is a group, it must have at least one descendant question which has an answer Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. It also only has meaning if the parent element is present. If a non-required 'group' item contains a 'required' question item, it's completely fine to omit the group (because it's not required) despite it having a required child. Similarly, 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 descendant item with a populated answer). The value for 'required' may come from the ElementDefinition referred to by .definition. |
| Control | 0..1 This element is affected by the following invariants: que-6 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Meaning if Missing | Items are assumed not to be required unless explicitly specified, though extensions may impose additional expectations |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 214. Questionnaire.item.repeats | |
| Definition | An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items). |
| Short | Whether the item may repeat |
| 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. When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. |
| Control | 0..1 This element is affected by the following invariants: que-6, que-13 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
| Meaning if Missing | Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 216. Questionnaire.item.readOnly | |
| Definition | An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. |
| Short | Don't allow human editing |
| Comments | If specified on a 'group', then all items beneath the specified group are read only. For questions, this only marks the answer associated with the specific item read only. Descendant questions are not impacted. 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. |
| Control | 0..1 This element is affected by the following invariants: que-9 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 218. Questionnaire.item.maxLength | |
| Definition | The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. |
| Short | No more than these many characters |
| 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. |
| Control | 0..1 This element is affected by the following invariants: que-10 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 220. Questionnaire.item.answerConstraint | |
| Definition | For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values other than those specified can be selected. |
| Short | optionsOnly | optionsOrType | optionsOrString |
| Control | 0..1 This element is affected by the following invariants: que-10, que-14 |
| Binding | The codes SHALL be taken from QuestionnaireAnswerConstraint (required to http://hl7.org/fhir/ValueSet/questionnaire-answer-constraint|5.0.0)Indicates differnt modes for restricting values when options or valueset are specified |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Introduces the ability for questions to have 'other' answers |
| Meaning if Missing | If not specified, answerConstraint is presumed to be 'optionsOnly' |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 222. Questionnaire.item.answerValueSet | |
| Definition | A reference to a value set containing a list of values representing permitted answers for a question. |
| Short | ValueSet containing permitted answers |
| 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. |
| Control | 0..1 This element is affected by the following invariants: que-5, que-4, que-14 |
| Type | canonical(ValueSet) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. Questionnaire.item.answerOption | |
| Definition | One of the permitted answers for the question. |
| Short | Permitted answer |
| 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. |
| Control | 0..* This element is affected by the following invariants: que-5, que-4, que-11, que-14 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 226. Questionnaire.item.answerOption.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 228. Questionnaire.item.answerOption.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 230. Questionnaire.item.answerOption.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 232. Questionnaire.item.answerOption.value[x] | |
| Definition | A potential answer that's allowed as the answer to this question. |
| Short | Answer value |
| Comments | The data type of the value must agree with the item.type. |
| Control | 1..1 |
| Binding | For example codes, see QuestionnaireAnswerCodes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: integer, date, time, string, Coding, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 234. Questionnaire.item.answerOption.initialSelected | |
| Definition | Indicates whether the answer value is selected when the list of possible answers is initially shown. |
| Short | Whether option is selected by default |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Meaning if Missing | Only selected items explicitly marked to be selected |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 236. Questionnaire.item.initial | |
| Definition | One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. |
| Short | Initial value(s) when item is first rendered |
| 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.answer[x] must agree with the item.type, and only repeating items can have more then one initial value. |
| Control | 0..* This element is affected by the following invariants: que-8, que-13, que-11 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | In some workflows, having defaults saves time. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. Questionnaire.item.initial.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 240. Questionnaire.item.initial.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 242. Questionnaire.item.initial.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 244. Questionnaire.item.initial.value[x] | |
| Definition | The actual value to for an initial answer. |
| Short | Actual value for initializing the question |
| Comments | The type of the initial value must be consistent with the type of the item. |
| Control | 1..1 |
| Binding | For example codes, see QuestionnaireAnswerCodes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|5.0.0)Allowed values to answer questions. |
| Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 246. Questionnaire.item.item | |
| Definition | Text, questions and other groups to be nested beneath a question or group. |
| Short | Nested questionnaire items |
| 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. |
| Control | 0..* |
| Type | Seettp://hl7.org/fhir/StructureDefinition/Questionnaire#Questionnaire.item |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Reports can consist of complex nested groups. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |