This page is part of the Structured Data Capture FHIR IG (v2.5.0: STU 3 Ballot 1) based on FHIR v3.5.0. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the sdc-questionnaire-render Profile.
Questionnaire | |
Definition | Defines additional capabilities for controlling the rendering of the questionnaire. |
Control | 0..* |
Alternate Names | Form, CRF, Survey |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.div.exists()) que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')) que-2: The link ids for groups and questions must be unique within the questionnaire (: descendants().linkId.isDistinct()) |
Questionnaire.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
Questionnaire.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Questionnaire.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Questionnaire.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from Common Languages |
Type | code |
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). |
Questionnaire.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Questionnaire.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint]]) | |
Definition | The base URL for the server to which questionnaire response associated with this questionnaire should be submitted. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: uri) |
Comments | Indicates that the form has been designed with an expectation that it will be submitted to the specified URI. If multiple endpoints are specified, expectation is that answers are submitted to all endpoints. If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site. If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier]]) | |
Definition | Unique identifier for a study protocol. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Identifier) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-designNote]]) | |
Definition | Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: markdown) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired]]) | |
Definition | If true, indicates that QuestionnaireResponse instances created against this questionnaire must have an associated Provenance record. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Comments | Systems may choose to require that the QuestionnaireResponse and referencing Provenance instance be submitted together as a single transaction using Bundle. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired |
Questionnaire.extension.valueBoolean | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | boolean |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive]]) | |
Definition | Indicates that the style extensions (style, markdown) and xhtml) in this resource are essential to the interpretation of the styled text and that it cannot be rendered without the style without losing essential information. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Comments | If set to true, all systems that claim to support this extension and which render elements of the resource containing this extension SHALL either render the content as required by the style extensions defined by this profile that are present in the resource or shall (if safe to do so based on their own rules), omit entirely the styled content they cannot render in accordance with the extensions. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
Questionnaire.extension.valueBoolean | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | boolean |
Questionnaire.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired]]) | |
Definition | Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Comments | If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.) The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired |
Questionnaire.extension.valueCodeableConcept | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | The type of signature needed. The codes SHOULD be taken from SignatureTypeCodes |
Type | CodeableConcept |
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.url | |
Definition | An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. |
Comments | The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension. |
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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Must Support | true |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI. |
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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Must Support | true |
Comments | There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version]. |
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. |
Control | 0..1 This element is affected by the following invariants: inv-0 |
Type | string |
Requirements | Support human navigation and code generation. |
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
Questionnaire.title | |
Definition | A short, descriptive, user-friendly title for the questionnaire. |
Control | 1..1 |
Type | string |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Questionnaire.title.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
Questionnaire.title.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.title.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-style]]) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.title.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-xhtml]]) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.title.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
Questionnaire.derivedFrom | |
Definition | The URL of a Questionnaire that this Questionnaire is based on. |
Control | 0..* |
Type | canonical(Questionnaire) |
Requirements | Allows a Questionnaire to be created based on another Questionnaire. |
Questionnaire.status | |
Definition | The status of this questionnaire. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Binding | The lifecycle status of an artifact. The codes SHALL be taken from PublicationStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | Allows filtering of questionnaires that are appropriate for use versus not. |
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. |
Control | 0..1 |
Type | boolean |
Must Support | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. |
Comments | Allows filtering of questionnaires that are appropriate for use versus not. |
Questionnaire.subjectType | |
Definition | The types of subjects that can be the subject of responses created for the questionnaire. |
Control | 1..1 |
Binding | One of the resource types defined as part of this version of FHIR. The codes SHALL be taken from ResourceType |
Type | code |
Must Support | true |
Comments | If none are specified, then the subject is unlimited. |
Questionnaire.date | |
Definition | Identifies when this version of the form was created. Changes whenever the form is updated. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
Alternate Names | Revision Date |
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
Questionnaire.publisher | |
Definition | The name of the organization or individual that published the questionnaire. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. |
Comments | Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context. |
Questionnaire.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Comments | May be a web site, an email address, a telephone number, etc. |
Questionnaire.description | |
Definition | A free text natural language description of the questionnaire from a consumer's perspective. |
Control | 0..1 |
Type | markdown |
Must Support | true |
Comments | This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created). |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
Questionnaire.useContext(context-gender) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | gender |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Gender codes for use in categorizing questionnaires The codes SHALL be taken from AdministrativeGender |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-age) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | age |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueRange | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Type | Range |
Must Support | true |
Questionnaire.useContext(context-focus) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | focus |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Condition codes for use in categorizing questionnaires For example codes, see Condition/Problem/DiagnosisCodes |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-user) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | user |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Practitioner type codes for use in categorizing questionnaires For example codes, see Provider Taxonomy Codes |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-workflow) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | workflow |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Encounter type codes for use in categorizing questionnaires For example codes, see http://hl7.org/fhir/ValueSet/v3-ActEncounterCode |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-task) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | task |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Task type codes for use in categorizing questionnaires For example codes, see http://hl7.org/fhir/ValueSet/v3-ActTaskCode |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-venue) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | venue |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Service Location type codes for use in categorizing questionnaires For example codes, see http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType |
Type | CodeableConcept |
Must Support | true |
Questionnaire.useContext(context-species) | |
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. |
Control | 0..* |
Type | UsageContext |
Must Support | true |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
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. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code | |
Definition | A code that identifies the type of context being specified by this usage context. |
Control | 1..1 |
Binding | A code that specifies a type of context being specified by a usage context. The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Questionnaire.useContext.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.useContext.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.useContext.code.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Fixed Value | http://terminology.hl7.org/CodeSystem/usage-context-type |
Questionnaire.useContext.code.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Questionnaire.useContext.code.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Fixed Value | species |
Questionnaire.useContext.code.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Questionnaire.useContext.code.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Questionnaire.useContext.valueCodeableConcept | |
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. |
Control | 1..1 |
Binding | Species codes for use in categorizing questionnaires For example codes, see Questionnaire Context Species |
Type | CodeableConcept |
Must Support | true |
Questionnaire.jurisdiction | |
Definition | A legal or geographic region in which the questionnaire is intended to be used. |
Control | 0..1 |
Binding | Countries and regions within which this artifact is targeted for use. The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Comments | It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. |
Questionnaire.purpose | |
Definition | Explanation of why this questionnaire is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
Must Support | true |
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. |
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. |
Control | 0..1 |
Type | markdown |
Must Support | true |
Requirements | Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content. |
Alternate Names | License, Restrictions |
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. |
Control | 0..1 |
Type | date |
Must Support | true |
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
Questionnaire.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
Control | 0..1 |
Type | date |
Must Support | true |
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. |
Comments | If specified, this date follows the original approval date. |
Questionnaire.effectivePeriod | |
Definition | The period during which the questionnaire content was or is planned to be in active use. |
Control | 0..1 |
Type | Period |
Must Support | 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. |
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. |
Questionnaire.code | |
Definition | An identifier for this question or group of questions in a particular terminology such as LOINC. |
Control | 0..1 |
Binding | Codes for questionnaires, groups and individual questions. For example codes, see QuestionnaireQuestionCodes |
Type | Coding |
Must Support | 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. |
Questionnaire.item | |
Definition | A particular question, question grouping or display text that is part of the questionnaire. |
Control | 1..* This element is affected by the following invariants: que-3 |
Type | BackboneElement |
Comments | The content of the questionnaire is constructed from an ordered, hierarchical collection of items. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) que-1: Group items must have nested items, display items cannot have nested items (: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())) que-10: Maximum length can only be declared for simple question types (: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()) que-11: If one or more answerOption is present, initial[x] must be missing (: answerOption.empty() or initial.empty()) que-12: If there are more than one enableWhen, enableBehavior must be specified (: enableWhen.count() > 2 implies enableBehavior.exists()) que-13: Can only have multiple initial values for repeating items (: repeats=true or initial.count() <= 1) que-3: Display items cannot have a "code" asserted (: type!='display' or code.empty()) que-4: A question cannot have both answerOption and answerValueSet (: answerOption.empty() or answerValueSet.empty()) que-5: Only 'choice' items can have answerValueSet (: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())) que-6: Required and repeat aren't permitted for display items (: type!='display' or (required.empty() and repeats.empty())) que-8: Initial values can't be specified for groups or display items (: (type!='group' and type!='display') or initial.empty()) que-9: Read-only can't be specified for "display" items (: type!='display' or readOnly.empty()) |
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. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-designNote]]) | |
Definition | Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: markdown) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay]]) | |
Definition | If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Comments | If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay |
Questionnaire.item.extension.valueBoolean | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | boolean |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-hidden]]) | |
Definition | If true, indicates that the extended item should not be displayed to the user. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Comments | If an item is hidden, all descendant items are hidden as well. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
Questionnaire.item.extension.valueBoolean | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | boolean |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode]]) | |
Definition | Identifies that the specified element should only appear in certain "modes" of operation. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: code) |
Is Modifier | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode |
Questionnaire.item.extension.valueCode | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. The codes SHALL be taken from QuestionnaireItemUsageMode |
Type | code |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl]]) | |
Definition | The type of data entry control or structure that should be used to render the item. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Comments | Different controls may be appropriate for different item types. It is up to the system rendering a questionnaire as to what controls it will support and for which data types. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl |
Questionnaire.item.extension.valueCodeableConcept | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | User interface controls or widgets used for questionnaire items. The codes SHALL be taken from QuestionnaireItemUIControlCodes; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation]]) | |
Definition | Identifies the desired orientation when rendering a list of choices (typically radio-box or check-box lists). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: code) |
Comments | Systems may choose to wrap answers rather than attempting to display them all in one row or column. Language conventions may determine the order in which the choices are listed (left-to-right or right-to-left, etc.). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation |
Questionnaire.item.extension.valueCode | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | Direction in which lists of possible answers should be displayed. The codes SHALL be taken from ChoiceListOrientation |
Type | code |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory]]) | |
Definition | Describes the intended purpose of the rendered text. For example - instructions, guidance on access control, maintenance information, etc. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory |
Questionnaire.item.extension.valueCodeableConcept | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | Identifies the purpose for a "display" item. The codes SHALL be taken from QuestionnaireTextCategories; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink]]) | |
Definition | A URL that resolves to additional supporting information or guidance related to the question. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: uri) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink |
Questionnaire.item.extension.valueUri | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | uri |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired]]) | |
Definition | Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Comments | If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.) The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired |
Questionnaire.item.extension.valueCodeableConcept | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | The type of signature needed. The codes SHOULD be taken from SignatureTypeCodes |
Type | CodeableConcept |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-choiceColumn]]) | |
Definition | Provides guidelines for rendering multi-column choices. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage) |
Comments | This can be used for choices drawn from value sets (where additional columns can be drawn from code system properties), for References where columns can be drawn from resource properties and for. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.extension.extension(path) | |
Definition | The element to display within the column (see notes). |
Control | 1..1 |
Type | Extension |
Questionnaire.item.extension.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | path |
Questionnaire.item.extension.extension.valueString | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension(label) | |
Definition | The label to appear at the top of the column. |
Control | 0..1 |
Type | Extension |
Questionnaire.item.extension.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | label |
Questionnaire.item.extension.extension.valueString | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension(width) | |
Definition | The size to allocate for the column within the table showing the choices. |
Control | 0..1 |
Type | Extension |
Comments | code missing = pixels; code = % = percentage. |
Questionnaire.item.extension.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | width |
Questionnaire.item.extension.extension.valueQuantity | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Quantity |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-choiceColumn |
Questionnaire.item.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-width]]) | |
Definition | When used with an item control that causes the question to appear as a column in a table, indicates the width to give to the column for this question. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Quantity) |
Comments | code missing = pixels; code = % = percentage. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) inv-1: code must be '%' and units UCUM or code must be omitted (: code.exists().not() or (code='%' and system='http://unitsofmeasure.org') |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-width |
Questionnaire.item.extension.valueQuantity | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | Quantity |
Questionnaire.item.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue]]) | |
Definition | For slider-based controls, indicates the step size to use when toggling the control up or down. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: integer) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Questionnaire.item.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue |
Questionnaire.item.extension.valueInteger | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | integer |
Questionnaire.item.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.linkId | |
Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient. |
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. |
Questionnaire.item.definition | |
Definition | This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:
|
Control | 0..1 |
Type | uri |
Requirements | A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition. |
Comments | The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. |
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). |
Control | 0..* This element is affected by the following invariants: que-3 |
Binding | Codes for questionnaires, groups and individual questions. For example codes, see QuestionnaireQuestionCodes |
Type | Coding |
Requirements | Allows linking of groups of questions to formal terminologies. |
Comments | The value may come from the ElementDefinition referred to by .definition. |
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. |
Control | 0..1 |
Type | string |
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 |
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. |
Questionnaire.item.prefix.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
Questionnaire.item.prefix.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.item.prefix.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-style]]) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.prefix.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-xhtml]]) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.prefix.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
Questionnaire.item.text | |
Definition | The name of a section, the text of a question or text content for a display item. |
Control | 0..1 |
Type | string |
Questionnaire.item.text.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
Questionnaire.item.text.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.item.text.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-style]]) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.text.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/rendering-xhtml]]) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.text.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
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.). |
Control | 1..1 |
Binding | Distinguishes groups from questions and display text and indicates data type for questions. The codes SHALL be taken from QuestionnaireItemType |
Type | code |
Must Support | true |
Requirements | Defines the format in which the user is to be prompted for the answer. |
Comments | Time is handled using "string". File is handled using Attachment. (Content can be sent as a contained binary). |
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. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | true |
Requirements | Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. |
Comments | If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) que-7: If the operator is 'exists', the value must be a boolean (: operator = 'exists' implies (answer is Boolean)) |
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. |
Control | 0..1 |
Type | string |
Questionnaire.item.enableWhen.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.enableWhen.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.enableWhen.question | |
Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
Control | 1..1 |
Type | string |
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. |
Questionnaire.item.enableWhen.operator | |
Definition | Specifies the criteria by which the question is enabled. |
Control | 1..1 |
Binding | The criteria by which a question is enabled. The codes SHALL be taken from QuestionnaireItemOperator |
Type | code |
Questionnaire.item.enableWhen.answer[x] | |
Definition | A value that the referenced question is tested using the specified operator in order for the item to be enabled. |
Control | 1..1 This element is affected by the following invariants: que-7 |
Binding | Allowed values to answer questions. For example codes, see QuestionnaireAnswerCodes |
Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Questionnaire.item.enableBehavior | |
Definition | Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
Control | 0..1 This element is affected by the following invariants: que-12 |
Binding | Controls how multiple enableWhen values are interpreted - whether all or any must be true. The codes SHALL be taken from EnableWhenBehavior |
Type | code |
Comments | This element must be specified if more than one enableWhen value is provided. |
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. |
Control | 0..1 This element is affected by the following invariants: que-6 |
Type | boolean |
Must Support | true |
Comments | Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition. |
Meaning if Missing | Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value |
Questionnaire.item.repeats | |
Definition | An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. |
Control | 0..1 This element is affected by the following invariants: que-6 |
Type | boolean |
Must Support | true |
Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
Comments | If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition. |
Meaning if Missing | Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value |
Questionnaire.item.readOnly | |
Definition | An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. |
Control | 0..1 This element is affected by the following invariants: que-9 |
Type | boolean |
Must Support | true |
Requirements | Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc. |
Comments | The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. |
Questionnaire.item.maxLength | |
Definition | The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. |
Control | 0..1 This element is affected by the following invariants: que-10 |
Type | integer |
Must Support | true |
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. |
Questionnaire.item.answerValueSet | |
Definition | A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. |
Control | 0..1 This element is affected by the following invariants: que-4, que-5 |
Type | canonical(ValueSet) |
Must Support | true |
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. |
Questionnaire.item.answerOption | |
Definition | One of the permitted answers for a "choice" or "open-choice" question. |
Control | 0..* This element is affected by the following invariants: que-4, que-5 |
Type | BackboneElement |
Comments | This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Questionnaire.item.answerOption.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.answerOption.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Questionnaire.item.answerOption.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix]]) | |
Definition | The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Questionnaire.item.answerOption.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.answerOption.value[x] | |
Definition | A potential answer that's allowed as the answer to this question. |
Control | 1..1 |
Binding | Allowed values to answer questions. For example codes, see QuestionnaireAnswerCodes |
Type | Choice of: integer, date, time, string, Coding, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | The data type of the value must agree with the item.type. |
Questionnaire.item.answerOption.initialSelected | |
Definition | Indicates whether the answer value is selected when the list of possible answers is initially shown. |
Control | 0..1 |
Type | boolean |
Comments | Use this instead of initial[v] if answerValueSet is present. |
Meaning if Missing | Only selected items explicitly marked to be selected |
Questionnaire.item.initial | |
Definition | One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. |
Control | 0..* This element is affected by the following invariants: que-8, que-13 |
Type | BackboneElement |
Must Support | true |
Requirements | In some workflows, having defaults saves time. |
Comments | The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Questionnaire.item.initial.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Questionnaire.item.initial.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.initial.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Questionnaire.item.initial.value[x] | |
Definition | The actual value to for an initial answer. |
Control | 1..1 |
Binding | Allowed values to answer questions. For example codes, see QuestionnaireAnswerCodes |
Type | Choice of: boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Comments | The type of the initial value must be consistent with the type of the item. |
Questionnaire.item.item | |
Definition | Text, questions and other groups to be nested beneath a question or group. |
Control | 0..* This element is affected by the following invariants: que-1 |
Type | See Questionnaire.item |
Must Support | true |
Requirements | Reports can consist of complex nested groups. |
Comments | There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting. |