Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-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..* |
| Alternate Names | Form, CRF, Survey |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())que-2: The link ids for groups and questions must be unique within the questionnaire ( descendants().linkId.isDistinct())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) que-2: The link ids for groups and questions must be unique within the questionnaire (descendants().linkId.isDistinct()) |
| 2. 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. |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Questionnaire.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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 | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Questionnaire.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Questionnaire.extension:derivedFrom | |
| Slice Name | derivedFrom |
| Definition | R4B: |
| Short | R4B: Instantiates protocol or definition (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4B: Instantiates protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R4B.Questionnaire for use in FHIR STU3, Questionnaire)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| 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 No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 10. Questionnaire.status | |
| Definition | The status of this questionnaire. Enables tracking the life-cycle of the content. |
| Short | draft | active | retired | unknown |
| Comments | Allows filtering of questionnaires that are appropriate for use vs. not. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 12. Questionnaire.experimental | |
| Definition | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| Short | For testing purposes, not real usage |
| Comments | Allows filtering of questionnaire that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental questionnaire in production. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Questionnaire | |
| 2. Questionnaire.meta | |
| 4. Questionnaire.meta.extension | |
| Control | 0..* |
| 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: |
| 6. Questionnaire.meta.extension:meta | |
| Slice Name | meta |
| Definition | R4B: |
| Short | R4B: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) |
| 8. Questionnaire.text | |
| 10. Questionnaire.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Questionnaire.text.extension:text | |
| Slice Name | text |
| Definition | R4B: |
| Short | R4B: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: text additional types) (Complex Extension) |
| 14. Questionnaire.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Questionnaire.extension:derivedFrom | |
| Slice Name | derivedFrom |
| Definition | R4B: |
| Short | R4B: Instantiates protocol or definition (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: Instantiates protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R4B.Questionnaire for use in FHIR STU3, Questionnaire)) |
| 18. Questionnaire.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 20. Questionnaire.identifier.extension | |
| Control | 0..* |
| 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: |
| 22. Questionnaire.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | R4B: |
| Short | R4B: identifier additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) |
| 24. Questionnaire.effectivePeriod | |
| 26. Questionnaire.effectivePeriod.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Questionnaire.effectivePeriod.extension:effectivePeriod | |
| Slice Name | effectivePeriod |
| Definition | R4B: |
| Short | R4B: effectivePeriod additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: effectivePeriod additional types) (Extension Type: Period) |
| 30. Questionnaire.useContext | |
| 32. Questionnaire.useContext.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. Questionnaire.useContext.extension:useContext | |
| Slice Name | useContext |
| Definition | R4B: |
| Short | R4B: The context that the content is intended to support additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: The context that the content is intended to support additional types) (Complex Extension) |
| 36. Questionnaire.contact | |
| 38. Questionnaire.contact.extension | |
| Control | 0..* |
| 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: |
| 40. Questionnaire.contact.extension:contact | |
| Slice Name | contact |
| Definition | R4B: |
| Short | R4B: contact additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: contact additional types) (Complex Extension) |
| 42. Questionnaire.subjectType | |
| 44. Questionnaire.subjectType.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.subjectType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. Questionnaire.subjectType.extension:subjectType | |
| Slice Name | subjectType |
| Definition | R4B: |
| Short | R4B: subjectType additional codes |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4B: subjectType additional codes) (Extension Type: code) |
| 48. Questionnaire.item | |
| 50. Questionnaire.item.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Questionnaire.item.extension:enableBehavior | |
| Slice Name | enableBehavior |
| Definition | R4B: |
| Short | R4B: all | any (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: all | any (new)) (Extension Type: code) |
| 54. Questionnaire.item.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: Actual value for initializing the question additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: Actual value for initializing the question additional types) (Extension Type: Attachment) |
| 56. Questionnaire.item.enableWhen | |
| 58. Questionnaire.item.enableWhen.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Questionnaire.item.enableWhen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 60. Questionnaire.item.enableWhen.extension:answer | |
| Slice Name | answer |
| Definition | R4B: |
| Short | R4B: Value for question comparison based on operator additional types |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4B: Value for question comparison based on operator additional types) (Extension Type: Choice of: decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) |
| 62. Questionnaire.item.enableWhen.hasAnswer | |
| 64. Questionnaire.item.enableWhen.hasAnswer.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Questionnaire.item.enableWhen.hasAnswer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. Questionnaire.item.enableWhen.hasAnswer.extension:operator | |
| Slice Name | operator |
| Definition | R4B: |
| Short | R4B: exists | = | != | > | < | >= | <= additional types |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R4B: exists | = | != | > | < | >= | <= additional types) (Extension Type: code) |
| 68. Questionnaire.item.options | |
| 70. Questionnaire.item.options.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.item.options.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. Questionnaire.item.options.extension:answerValueSet | |
| Slice Name | answerValueSet |
| Definition | R4B: |
| Short | R4B: answerValueSet additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: answerValueSet additional types) (Extension Type: uri(Cross-version Profile for R4B.ValueSet for use in FHIR STU3, ValueSet)) |
| 74. Questionnaire.item.option | |
| 76. Questionnaire.item.option.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Questionnaire.item.option.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Questionnaire.item.option.extension:value | |
| Slice Name | value |
| Definition | R4B: |
| Short | R4B: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: value additional types) (Extension Type: Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) |
| 80. Questionnaire.item.option.extension:initialSelected | |
| Slice Name | initialSelected |
| Definition | R4B: |
| Short | R4B: Whether option is selected by default (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4B: Whether option is selected by default (new)) (Extension Type: boolean) |
| 82. Questionnaire.item.initialReference | |
| 84. Questionnaire.item.initialReference.extension:alternateReference | |
| Slice Name | alternateReference |
| Definition | R4B: |
| Short | R4B: Actual value for initializing the question additional types |
| Comments | Element |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
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..* | ||||
| Alternate Names | Form, CRF, Survey | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())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 | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. Questionnaire.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. Questionnaire.meta.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| 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.extension:meta | |||||
| Slice Name | meta | ||||
| Definition | R4B: | ||||
| Short | R4B: meta additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: meta additional types) (Extension Type: Meta) | ||||
| 12. Questionnaire.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This values 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 | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 14. Questionnaire.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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 | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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 All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 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 Common Tags (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 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. | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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 | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 26. Questionnaire.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 28. Questionnaire.text.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 30. Questionnaire.text.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. Questionnaire.text.extension:text | |||||
| Slice Name | text | ||||
| Definition | R4B: | ||||
| Short | R4B: text additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: text additional types) (Complex Extension) | ||||
| 34. Questionnaire.text.status | |||||
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
| Short | generated | extensions | additional | empty | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)The status of a resource narrative | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 36. Questionnaire.text.div | |||||
| Definition | The actual narrative content, a stripped down version of XHTML. | ||||
| Short | Limited xhtml content | ||||
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
| Control | 1..1 | ||||
| Type | xhtml | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlchecks()) | ||||
| 38. Questionnaire.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 40. Questionnaire.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. Questionnaire.extension:derivedFrom | |||||
| Slice Name | derivedFrom | ||||
| Definition | R4B: | ||||
| Short | R4B: Instantiates protocol or definition (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Instantiates protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R4B.Questionnaire for use in FHIR STU3, Questionnaire)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 44. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 46. 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see Technical and Business Versions. | ||||
| Short | Logical URI to reference this questionnaire (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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. | ||||
| 48. 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 | Additional identifier for the questionnaire | ||||
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to 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..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
| 50. Questionnaire.identifier.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 52. Questionnaire.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| 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: | ||||
| 54. Questionnaire.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | R4B: | ||||
| Short | R4B: identifier additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: identifier additional types) (Extension Type: Identifier) | ||||
| 56. Questionnaire.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary (If known) | ||||
| Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. 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|3.0.2)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| 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. | ||||
| 58. Questionnaire.identifier.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 | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|3.0.2)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| 60. Questionnaire.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| 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 | ||||
| 62. Questionnaire.identifier.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 Rendered Value extension. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| 64. Questionnaire.identifier.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 | ||||
| Summary | true | ||||
| 66. Questionnaire.identifier.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) | ||||
| Summary | true | ||||
| 68. 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 questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the questionnaire with the format [url]|[version]. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 70. 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 alpha-numeric type name to ensure that it is computable friendly. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| 72. 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 74. Questionnaire.status | |||||
| Definition | The status of this questionnaire. Enables tracking the life-cycle of the content. | ||||
| Short | draft | active | retired | unknown | ||||
| Comments | Allows filtering of questionnaires that are appropriate for use vs. not. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 76. Questionnaire.experimental | |||||
| Definition | A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. | ||||
| Short | For testing purposes, not real usage | ||||
| Comments | Allows filtering of questionnaire that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental questionnaire in production. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. | ||||
| 78. Questionnaire.date | |||||
| Definition | The date (and optionally time) when the questionnaire was published. The date must change if and 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 this was last changed | ||||
| Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| 80. Questionnaire.publisher | |||||
| Definition | The name of the individual or organization that published the questionnaire. | ||||
| Short | Name of the publisher (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..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. | ||||
| 82. 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 why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 84. Questionnaire.purpose | |||||
| Definition | Explaination 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 86. 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 / editorial corrections. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 88. Questionnaire.lastReviewDate | |||||
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | ||||
| Short | When the questionnaire was last reviewed | ||||
| Comments | If specified, this is usually after the approval date. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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. | ||||
| 90. 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 measure intended to be used for the year 2016 might be published in 2015. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the questionnaire are or are expected to be used instead. | ||||
| 92. Questionnaire.effectivePeriod.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 94. Questionnaire.effectivePeriod.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 96. Questionnaire.effectivePeriod.extension:effectivePeriod | |||||
| Slice Name | effectivePeriod | ||||
| Definition | R4B: | ||||
| Short | R4B: effectivePeriod additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: effectivePeriod additional types) (Extension Type: Period) | ||||
| 98. Questionnaire.effectivePeriod.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Starting time with inclusive boundary | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 100. Questionnaire.effectivePeriod.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| 102. Questionnaire.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances. | ||||
| Short | Context the content is intended to support | ||||
| Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| 104. Questionnaire.useContext.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 106. Questionnaire.useContext.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.useContext.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 108. Questionnaire.useContext.extension:useContext | |||||
| Slice Name | useContext | ||||
| Definition | R4B: | ||||
| Short | R4B: The context that the content is intended to support additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: The context that the content is intended to support additional types) (Complex Extension) | ||||
| 110. Questionnaire.useContext.code | |||||
| Definition | A code that identifies the type of context being specified by this usage context. | ||||
| Short | Type of context being specified | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to http://hl7.org/fhir/ValueSet/usage-context-type|3.0.2)A code that specifies a type of context being specified by a usage context | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 112. Questionnaire.useContext.value[x] | |||||
| Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. | ||||
| Short | Value that defines the context | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see Context of Use ValueSet (example to http://hl7.org/fhir/ValueSet/use-context|3.0.2)A code that defines the specific value for the context being specified | ||||
| Type | Choice of: CodeableConcept, Quantity, Range | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Summary | true | ||||
| 114. 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. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)Countries and regions within which this artifact is targeted for use | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 116. Questionnaire.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||
| Short | Contact details for the publisher | ||||
| Comments | May be a web site, an email address, a telephone number, etc. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 118. Questionnaire.contact.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 120. Questionnaire.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| 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: | ||||
| 122. Questionnaire.contact.extension:contact | |||||
| Slice Name | contact | ||||
| Definition | R4B: | ||||
| Short | R4B: contact additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R4B: contact additional types) (Complex Extension) | ||||
| 124. Questionnaire.contact.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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 126. Questionnaire.contact.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 | ||||
| Summary | true | ||||
| 128. 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content. | ||||
| Alternate Names | License, Restrictions | ||||
| 130. Questionnaire.code | |||||
| Definition | An identifier for this question or group of questions in a particular terminology such as LOINC. | ||||
| Short | Concept that represents the overall questionnaire | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Questionnaire Question Codes (example to http://hl7.org/fhir/ValueSet/questionnaire-questions|3.0.2)Codes for questionnaires, groups and individual questions | ||||
| Type | Coding | ||||
| 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. | ||||
| 132. 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 | 0..* | ||||
| Binding | The codes SHALL be taken from ResourceType ![]() (required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)One of the resource types defined as part of FHIR. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 134. Questionnaire.subjectType.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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 136. Questionnaire.subjectType.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.subjectType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 138. Questionnaire.subjectType.extension:subjectType | |||||
| Slice Name | subjectType | ||||
| Definition | R4B: | ||||
| Short | R4B: subjectType additional codes | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: subjectType additional codes) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 140. Questionnaire.subjectType.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 142. Questionnaire.item | |||||
| Definition | A particular question, question grouping or display text that is part of the questionnaire. | ||||
| Short | Questions and sections within the Questionnaire | ||||
| Comments | The content of the questionnaire is constructed from an ordered, hierarchical collection of items. | ||||
| Control | 0..* This element is affected by the following invariants: que-3 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))que-9: Read-only can't be specified for "display" items ( type!='display' or readOnly.empty())que-8: Default values can't be specified for groups or display items ( (type!='group' and type!='display') or initial.empty())que-6: Required and repeat aren't permitted for display items ( type!='display' or (required.empty() and repeats.empty()))que-5: Only 'choice' items can have options ( (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()))que-4: A question cannot have both option and options ( option.empty() or options.empty())que-3: Display items cannot have a "code" asserted ( type!='display' or code.empty())que-10: Maximum length can only be declared for simple question types ( (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty())que-1: Group items must have nested items, display items cannot have nested items ( (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())) | ||||
| 144. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 146. Questionnaire.item.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 148. Questionnaire.item.extension:enableBehavior | |||||
| Slice Name | enableBehavior | ||||
| Definition | R4B: | ||||
| Short | R4B: all | any (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: all | any (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 150. Questionnaire.item.extension:value | |||||
| Slice Name | value | ||||
| Definition | R4B: | ||||
| Short | R4B: Actual value for initializing the question additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Actual value for initializing the question additional types) (Extension Type: Attachment) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 152. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 154. 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. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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. | ||||
| 156. Questionnaire.item.definition | |||||
| Definition | A reference to an ElementDefinition that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition:
Any information provided in these elements on a Questionnaire Item overrides the information from the definition. | ||||
| Short | ElementDefinition - details for the item | ||||
| Comments | the URI refers to an ElementDefinition in either a StructureDefinition or a DataElement, 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. Note that LOINC codes implicitly define DataElement resources. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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. | ||||
| 158. Questionnaire.item.code | |||||
| Definition | A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). | ||||
| Short | Corresponding concept for this item in a terminology | ||||
| Comments | The value may come from the ElementDefinition referred to by .definition. | ||||
| Control | 0..* This element is affected by the following invariants: que-3 | ||||
| Binding | For example codes, see Questionnaire Question Codes (example to http://hl7.org/fhir/ValueSet/questionnaire-questions|3.0.2)Codes for questionnaires, groups and individual questions | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows linking of groups of questions to formal terminologies. | ||||
| 160. 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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 | ||||
| 162. 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 | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 164. Questionnaire.item.type | |||||
| Definition | The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.). | ||||
| 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 | ||||
| Binding | The codes SHALL be taken from QuestionnaireItemType (required to http://hl7.org/fhir/ValueSet/item-type|3.0.2)Distinguishes groups from questions and display text and indicates data type for questions | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Defines the format in which the user is to be prompted for the answer. | ||||
| 166. 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 item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Requirements | Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element ( hasAnswer.exists() xor answer.exists()) | ||||
| 168. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 170. Questionnaire.item.enableWhen.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.enableWhen.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 172. Questionnaire.item.enableWhen.extension:answer | |||||
| Slice Name | answer | ||||
| Definition | R4B: | ||||
| Short | R4B: Value for question comparison based on operator additional types | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Value for question comparison based on operator additional types) (Extension Type: Choice of: decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 174. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 176. Questionnaire.item.enableWhen.question | |||||
| Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. | ||||
| Short | Question that determines whether item is enabled | ||||
| Comments | If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 178. Questionnaire.item.enableWhen.hasAnswer | |||||
| Definition | An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false). | ||||
| Short | Enable when answered or not | ||||
| Comments | If answered=false and answer values are also provided, then they are treated as "or". I.e. "Enable if the question is unanswered or the answer is one of the specified values". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.). | ||||
| Control | 0..1 This element is affected by the following invariants: que-7 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 180. Questionnaire.item.enableWhen.hasAnswer.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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 182. Questionnaire.item.enableWhen.hasAnswer.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.enableWhen.hasAnswer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 184. Questionnaire.item.enableWhen.hasAnswer.extension:operator | |||||
| Slice Name | operator | ||||
| Definition | R4B: | ||||
| Short | R4B: exists | = | != | > | < | >= | <= additional types | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: exists | = | != | > | < | >= | <= additional types) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 186. Questionnaire.item.enableWhen.hasAnswer.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for boolean | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 188. Questionnaire.item.enableWhen.answer[x] | |||||
| Definition | An answer that the referenced question must match in order for the item to be enabled. | ||||
| Short | Value question must have | ||||
| Comments | Multiple answers are treated as "or". E.g. Enable if question 1 = A, C or E. Components not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it is ok if the answer has a "display" element. I.e. treat the answer as a 'pattern'. The dataType of this element must be the same as the data type of the question being referenced. | ||||
| Control | 0..1 This element is affected by the following invariants: que-7 | ||||
| Binding | For example codes, see Questionnaire Answer Codes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|3.0.2)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] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 190. 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 | Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition. | ||||
| Control | 0..1 This element is affected by the following invariants: que-6 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Default Value | false | ||||
| 192. Questionnaire.item.repeats | |||||
| Definition | An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups. | ||||
| 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 or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). The value may come from the ElementDefinition referred to by .definition. | ||||
| Control | 0..1 This element is affected by the following invariants: que-6 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. | ||||
| Default Value | false | ||||
| 194. 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 | 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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. | ||||
| 196. 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 this 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 198. Questionnaire.item.options | |||||
| Definition | A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" 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-4, que-5 | ||||
| Type | Reference(ValueSet) | ||||
| 200. Questionnaire.item.options.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 202. Questionnaire.item.options.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.options.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 204. Questionnaire.item.options.extension:answerValueSet | |||||
| Slice Name | answerValueSet | ||||
| Definition | R4B: | ||||
| Short | R4B: answerValueSet additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R4B: answerValueSet additional types) (Extension Type: uri(Cross-version Profile for R4B.ValueSet for use in FHIR STU3, ValueSet)) | ||||
| 206. Questionnaire.item.options.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 208. Questionnaire.item.options.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 210. Questionnaire.item.options.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 212. Questionnaire.item.option | |||||
| Definition | One of the permitted answers for a "choice" or "open-choice" question. | ||||
| Short | Permitted answer | ||||
| Comments | This element can be used when the value set machinery of options is deemed too cumbersome or when there's a need to capture options that are not codes. | ||||
| Control | 0..* This element is affected by the following invariants: que-4, que-5 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 214. Questionnaire.item.option.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 216. Questionnaire.item.option.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.option.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 218. Questionnaire.item.option.extension:value | |||||
| Slice Name | value | ||||
| Definition | R4B: | ||||
| Short | R4B: value additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: value additional types) (Extension Type: Reference(Cross-version Profile for R4B.Resource for use in FHIR STU3, Resource)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 220. Questionnaire.item.option.extension:initialSelected | |||||
| Slice Name | initialSelected | ||||
| Definition | R4B: | ||||
| Short | R4B: Whether option is selected by default (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4B: Whether option is selected by default (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 222. Questionnaire.item.option.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 224. Questionnaire.item.option.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 Questionnaire Answer Codes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|3.0.2)Allowed values to answer questions. | ||||
| Type | Choice of: integer, date, time, string, Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 226. Questionnaire.item.initial[x] | |||||
| Definition | The value that should be defaulted when initially rendering the questionnaire for user input. | ||||
| Short | Default value 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 default values can influence results. The data type of initial[x] must agree with the item.type. | ||||
| Control | 0..1 This element is affected by the following invariants: que-8 | ||||
| Binding | For example codes, see Questionnaire Answer Codes (example to http://hl7.org/fhir/ValueSet/questionnaire-answers|3.0.2)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] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | In some workflows, having defaults saves time. | ||||
| 228. Questionnaire.item.initial[x].id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 230. Questionnaire.item.initial[x].extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on Questionnaire.item.initial[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 232. Questionnaire.item.initial[x].extension:alternateReference | |||||
| Slice Name | alternateReference | ||||
| Definition | R4B: | ||||
| Short | R4B: Actual value for initializing the question additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 234. 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..* This element is affected by the following invariants: que-1 | ||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Questionnaire#Questionnaire.item | ||||
| Requirements | Reports can consist of complex nested groups. | ||||