FHIR-Profile: Questionnaire
Description
This profile holds information about a structured set of questions. A Questionnaire is an organized collection of questions intended to solicit information from patients. Within Selfapy's domain, questionnaires will contain questions to standardized symptom questionnaires (i.e. PHQ-9). The Questionnaire defines the questions to be asked, how they are ordered and grouped, any intervening instructional text and what the constraints are on the allowed answers.
Answers to questionnaires are stored in the resource QuestionnaireResponse Profile.
Resource Information
Canonical Resource URL | Simplifier Profile | Profile Status |
---|---|---|
https://www.selfapy.com/fhir/StructureDefinition/questionnaire | https://simplifier.net/selfapy/questionnaire | active |
Tree
Questionnaire | I | Questionnaire | Element idQuestionnaire A structured set of questions Alternate namesForm, CRF, Survey DefinitionDieses Profil bildet einen Fragebogen ab.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idQuestionnaire.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 1..1 | id | There are no (further) constraints on this element Element idQuestionnaire.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 1..1 | instant | There are no (further) constraints on this element Element idQuestionnaire.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..0 | uri | There are no (further) constraints on this element Element idQuestionnaire.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | Σ | 1..* | canonical(StructureDefinition) | Element idQuestionnaire.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Sliced:Unordered, Open, by $this(Value) Constraints
|
security | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..0 | Coding | There are no (further) constraints on this element Element idQuestionnaire.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idQuestionnaire.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | S | 1..1 | codeBinding | Element idQuestionnaire.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
|
text | 0..1 | Narrative | Element idQuestionnaire.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionIn diesem Element können die, in der Instanz, enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.text.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.text.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
status | 1..1 | codeBindingFixed Value | Element idQuestionnaire.text.status generated | extensions | additional | empty DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Note that FHIR strings SHALL NOT exceed 1MB in size The status of a resource narrative.
extensions
| |
div | I | 1..1 | xhtml | There are no (further) constraints on this element Element idQuestionnaire.text.div Limited xhtml content DefinitionThe actual narrative content, a stripped down version of XHTML. The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.
|
contained | 0..0 | Resource | There are no (further) constraints on this element Element idQuestionnaire.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.url Canonical identifier for this questionnaire, represented as a URI (globally unique) DefinitionAn 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. … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
|
identifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idQuestionnaire.identifier Additional identifier for the questionnaire DefinitionA 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. Allows externally provided and/or usable business identifiers to be easily associated with the module. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 1..1 | CodeableConceptBindingPattern | Element idQuestionnaire.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
{ "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "version": "2.9", "code": "RI", "display": "Resource identifier" } ] }
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | CodingPattern | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "version": "2.9", "code": "RI", "display": "Resource identifier" }
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriPattern | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
http://terminology.hl7.org/CodeSystem/v2-0203
|
version | Σ | 1..1 | stringPattern | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.version Version of the system - if relevant DefinitionThe 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. 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.
2.9
|
code | Σ | 1..1 | codePattern | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
RI
|
display | Σ | 1..1 | stringPattern | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
Resource identifier
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
system | S Σ | 1..1 | uriFixed Value | Element idQuestionnaire.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
urn:ietf:rfc:3986
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element idQuestionnaire.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idQuestionnaire.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.version Business version of the questionnaire DefinitionThe 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. 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].
|
name | Σ I | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.name Name for this questionnaire (computer friendly) DefinitionA 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. Support human navigation and code generation. 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.
|
title | S Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.title Name for this questionnaire (human friendly) DefinitionA short, descriptive, user-friendly title for the questionnaire. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
derivedFrom | 0..0 | canonical(Questionnaire) | There are no (further) constraints on this element Element idQuestionnaire.derivedFrom Instantiates protocol or definition DefinitionThe URL of a Questionnaire that this Questionnaire is based on. Allows a Questionnaire to be created based on another Questionnaire.
| |
status | Σ ?! | 1..1 | codeBindingPattern | Element idQuestionnaire.status draft | active | retired | unknown DefinitionThe status of this questionnaire. Enables tracking the life-cycle of the content. Allows filtering of questionnaires that are appropriate for use versus not. The lifecycle status of an artifact.
active
|
experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.experimental For testing purposes, not real usage DefinitionA 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. Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. Allows filtering of questionnaires that are appropriate for use versus not.
|
subjectType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.subjectType Resource that can be subject of QuestionnaireResponse DefinitionThe types of subjects that can be the subject of responses created for the questionnaire. If none are specified, then the subject is unlimited. One of the resource types defined as part of this version of FHIR.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idQuestionnaire.date Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. 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.
|
publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the questionnaire. Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. 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.
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idQuestionnaire.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
description | 0..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.description Natural language description of the questionnaire DefinitionA free text natural language description of the questionnaire from a consumer's perspective. 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).
| |
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idQuestionnaire.useContext The context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idQuestionnaire.jurisdiction Intended jurisdiction for questionnaire (if applicable) DefinitionA legal or geographic region in which the questionnaire is intended to be used. It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use.
|
purpose | 0..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.purpose Why this questionnaire is defined DefinitionExplanation of why this questionnaire is needed and why it has been designed as it has. 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.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.copyright Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
approvalDate | 0..1 | date | There are no (further) constraints on this element Element idQuestionnaire.approvalDate When the questionnaire was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
| |
lastReviewDate | 0..1 | date | There are no (further) constraints on this element Element idQuestionnaire.lastReviewDate When the questionnaire was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. 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. If specified, this date follows the original approval date.
| |
effectivePeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod When the questionnaire is expected to be used DefinitionThe period during which the questionnaire content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead. 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.
|
code | Σ | 0..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.code Concept that represents the overall questionnaire DefinitionAn identifier for this question or group of questions in a particular terminology such as LOINC. Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Codes for questionnaires, groups and individual questions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.code.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.code.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.code.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.code.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
item | S I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item Questions and sections within the Questionnaire DefinitionA particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
linkId | S | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.linkId Unique id for item in questionnaire DefinitionAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. 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. 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.
|
definition | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.item.definition ElementDefinition - details for the item DefinitionThis 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:
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. 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.
| |
code | S I | 0..1 | Coding | There are no (further) constraints on this element Element idQuestionnaire.item.code Corresponding concept for this item in a terminology DefinitionA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Allows linking of groups of questions to formal terminologies. The value may come from the ElementDefinition referred to by .definition. Codes for questionnaires, groups and individual questions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.code.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.item.code.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.code.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.code.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
prefix | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.prefix E.g. "1(a)", "2.5.3" Alternate nameslabel DefinitionA short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. 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. 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.
| |
text | S | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.text Primary text for the item DefinitionThe name of a section, the text of a question or text content for a display item. When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.
|
type | S | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.type group | display | boolean | decimal | integer | date | dateTime + DefinitionThe 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.). Defines the format in which the user is to be prompted for the answer. Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. Distinguishes groups from questions and display text and indicates data type for questions.
|
enableWhen | ?! I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen Only allow data when DefinitionA constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
question | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.question Question that determines whether item is enabled DefinitionThe linkId for the question whose answer (or lack of answer) governs whether this item is enabled. 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.
| |
operator | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.operator exists | = | != | > | < | >= | <= DefinitionSpecifies the criteria by which the question is enabled. Note that FHIR strings SHALL NOT exceed 1MB in size The criteria by which a question is enabled.
| |
answer[x] | I | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.answer[x] Value for question comparison based on operator DefinitionA value that the referenced question is tested using the specified operator in order for the item to be enabled. Allowed values to answer questions.
| |
answerBoolean | boolean | There are no (further) constraints on this element Data type | ||
answerDecimal | decimal | There are no (further) constraints on this element Data type | ||
answerInteger | integer | There are no (further) constraints on this element Data type | ||
answerDate | date | There are no (further) constraints on this element Data type | ||
answerDateTime | dateTime | There are no (further) constraints on this element Data type | ||
answerTime | time | There are no (further) constraints on this element Data type | ||
answerString | string | There are no (further) constraints on this element Data type | ||
answerCoding | Coding | There are no (further) constraints on this element Data type | ||
answerQuantity | Quantity | There are no (further) constraints on this element Data type | ||
answerReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
enableBehavior | I | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableBehavior all | any DefinitionControls how multiple enableWhen values are interpreted - whether all or any must be true. This element must be specified if more than one enableWhen value is provided. Controls how multiple enableWhen values are interpreted - whether all or any must be true.
|
required | I | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.required Whether the item must be included in data results DefinitionAn indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. 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. Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value
|
repeats | I | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.repeats Whether the item may repeat DefinitionAn 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. Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. 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. Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
|
readOnly | I | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.readOnly Don't allow human editing DefinitionAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. 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. 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.
|
maxLength | I | 0..1 | integer | There are no (further) constraints on this element Element idQuestionnaire.item.maxLength No more than this many characters DefinitionThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. 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.
|
answerValueSet | I | 0..1 | canonical(ValueSet) | There are no (further) constraints on this element Element idQuestionnaire.item.answerValueSet Valueset containing permitted answers DefinitionA reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.
|
answerOption | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption Permitted answer DefinitionOne of the permitted answers for a "choice" or "open-choice" question. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
value[x] | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.value[x] Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions.
| ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
initialSelected | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.initialSelected Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Use this instead of initial[v] if answerValueSet is present. Only selected items explicitly marked to be selected
| |
initial | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.initial Initial value(s) when item is first rendered DefinitionOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. In some workflows, having defaults saves time. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.initial.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.initial.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.initial.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
value[x] | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.item.initial.value[x] Actual value for initializing the question DefinitionThe actual value to for an initial answer. The type of the initial value must be consistent with the type of the item. Allowed values to answer questions.
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueReference | Reference(Resource) | There are no (further) constraints on this element Data type | ||
item | I | 0..* | see (item) | There are no (further) constraints on this element Element idQuestionnaire.item.item Nested questionnaire items DefinitionText, questions and other groups to be nested beneath a question or group. Reports can consist of complex nested groups. 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.
|
url | S | 0..1 | There are no (further) constraints on this element Element idQuestionnaire.url |
FHIR-Questionnaire Table
Questionnaire | .. | |
Questionnaire.meta | 1.. | |
Questionnaire.meta.versionId | 1.. | |
Questionnaire.meta.lastUpdated | 1.. | |
Questionnaire.meta.source | ..0 | |
Questionnaire.meta.profile | 1.. | |
Questionnaire.meta.security | ..0 | |
Questionnaire.meta.tag | ..0 | |
Questionnaire.implicitRules | ..0 | |
Questionnaire.language | 1.. | |
Questionnaire.text | .. | |
Questionnaire.text.status | .. | |
Questionnaire.contained | ..0 | |
Questionnaire.identifier | 1..1 | |
Questionnaire.identifier.use | ..0 | |
Questionnaire.identifier.type | 1.. | |
Questionnaire.identifier.type.coding | 1..1 | |
Questionnaire.identifier.type.coding.system | 1.. | |
Questionnaire.identifier.type.coding.version | 1.. | |
Questionnaire.identifier.type.coding.code | 1.. | |
Questionnaire.identifier.type.coding.display | 1.. | |
Questionnaire.identifier.type.text | ..0 | |
Questionnaire.identifier.system | 1.. | |
Questionnaire.identifier.value | 1.. | |
Questionnaire.identifier.period | ..0 | |
Questionnaire.identifier.assigner | ..0 | |
Questionnaire.title | .. | |
Questionnaire.url | 0..1 | |
Questionnaire.derivedFrom | ..0 | |
Questionnaire.status | .. | |
Questionnaire.subjectType | .. | |
Questionnaire.date | .. | |
Questionnaire.code | .. | |
Questionnaire.code.system | 1.. | |
Questionnaire.code.version | 1.. | |
Questionnaire.code.code | 1.. | |
Questionnaire.code.display | 1.. | |
Questionnaire.code.userSelected | ..0 | |
Questionnaire.item | .. | |
Questionnaire.item.linkId | .. | |
Questionnaire.item.code | ..1 | |
Questionnaire.item.code.system | 1.. | |
Questionnaire.item.code.version | 1.. | |
Questionnaire.item.code.code | 1.. | |
Questionnaire.item.code.display | 1.. | |
Questionnaire.item.code.userSelected | ..0 | |
Questionnaire.item.prefix | ..0 | |
Questionnaire.item.text | .. | |
Questionnaire.item.type | .. |