Questionnaire | I | | Questionnaire | There are no (further) constraints on this element Element IdShort description A structured set of questions Alternate names Form, CRF, Survey Definition A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Data Type Questionnaire Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - que-2:The link ids for groups and questions must be unique within the questionnaire
descendants().linkId.isDistinct() - que-0:Name should be usable as an identifier for the module by machine processing applications such as code generation
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Mappings- rim:Entity. Role, or Act
- workflow:Definition
- rim:Observation[moodCode=DEF]
|
language | S | 0..1 | codeBinding | Element IdShort description Sprache des Moduls Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data Type code Binding A human language. CommonLanguages (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdShort description Canonical identifier for this questionnaire, represented as a URI (globally unique) Definition An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
Requirements … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.
Comments The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.url
- w5:FiveWs.identifier
- rim:.identifier[scope=BUSN;reliability=ISS]
|
identifier | S Σ | 0..* | Identifier | Element IdShort description Identifikator eines Moduls Definition Identifikator eines Moduls. Dient dem Zweck des systemübergreifen Identifizierens, z.B. beim verteilten Consent Management
Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module.
Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- workflow:Definition.identifier
- w5:FiveWs.identifier
- rim:.identifier
- objimpl:no-gen-base
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdQuestionnaire.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdQuestionnaire.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdQuestionnaire.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdQuestionnaire.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdQuestionnaire.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
version | S Σ | 1..1 | string | Element IdShort description Versionsangabe des Moduls Definition The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Comments There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version].
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.version
- w5:FiveWs.version
- rim:N/A (to add?)
|
name | S Σ I | 1..1 | string | Element IdShort description Name des Consent Moduls Definition A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Requirements Support human navigation and code generation.
Comments The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
title | S Σ | 0..1 | string | Element IdShort description Titel des Consent Moduls zur Darstellung auf dem späteren Consent Template Definition A short, descriptive, user-friendly title for the questionnaire.
Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.title
- rim:.title
|
derivedFrom | | 0..* | canonical(Questionnaire) | There are no (further) constraints on this element Element IdQuestionnaire.derivedFrom Short description Instantiates protocol or definition Definition The URL of a Questionnaire that this Questionnaire is based on.
Requirements Allows a Questionnaire to be created based on another Questionnaire.
Comments Data Type canonical(Questionnaire) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.derivedFrom
- rim:.outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdShort description draft | active | retired | unknown Definition The status of this questionnaire. Enables tracking the life-cycle of the content.
Comments Allows filtering of questionnaires that are appropriate for use versus not.
Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.status
- w5:FiveWs.status
- rim:.status
|
experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.experimental Short description For testing purposes, not real usage Definition A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.
Comments Allows filtering of questionnaires that are appropriate for use versus not.
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.experimental
- w5:FiveWs.class
- rim:N/A
|
subjectType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdQuestionnaire.subjectType Short description Resource that can be subject of QuestionnaireResponse Definition The types of subjects that can be the subject of responses created for the questionnaire.
Comments If none are specified, then the subject is unlimited.
Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.subject[x]
- rim:.outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description Date last changed Alternate names Revision Date Definition The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.date
- w5:FiveWs.recorded
- rim:.participation[typeCode=AUT].time
|
publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the questionnaire.
Requirements Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.
Comments Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.publisher
- w5:FiveWs.witness
- rim:.participation[typeCode=AUT].role
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element IdShort description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher.
Comments May be a web site, an email address, a telephone number, etc.
Data Type ContactDetail Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.contact
- rim:.participation[typeCode=CALLBCK].role
|
description | S | 0..1 | markdown | Element IdQuestionnaire.description Short description Kurzzusammenfassung des Inhaltes Definition A free text natural language description of the questionnaire from a consumer's perspective.
Comments This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.description
- rim:.text
|
useContext | S Σ | 1..* | UsageContext | There are no (further) constraints on this element Element IdShort description The context that the content is intended to support Definition The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
Requirements Assist in searching for appropriate content.
Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Data Type UsageContext Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.useContext
- rim:N/A (to add?)
|
code | Σ | 1..1 | CodingBinding | Element IdQuestionnaire.useContext.code Short description Type of context being specified Definition A code that identifies the type of context being specified by this usage context.
Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
Data Type Coding Binding A code that specifies a type of context being specified by a usage context. ConsentManagementQuestionnaireComponents (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdQuestionnaire.useContext.code.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code.
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.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.useContext.code.version Short description Version of the system - if relevant 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:C*E.7
- rim:./codeSystemVersion
- orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdQuestionnaire.useContext.code.code Short description Symbol in syntax defined by the system 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).
Requirements Need to refer to a particular code in the system.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type code Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.useContext.code.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:C*E.2 - but note this is not well followed
- rim:CV.displayName
- orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.useContext.code.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
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.
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:Sometimes implied by being first
- rim:CD.codingRationale
- orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
value[x] | S Σ | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.useContext.value[x] Short description Value that defines the context Definition A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.useContext.value[x].reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdQuestionnaire.useContext.value[x].type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdQuestionnaire.useContext.value[x].identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.useContext.value[x].display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueReference | | | Reference(Consent Management Domain Organization | Consent Management Domain Research Study) | Data Type Reference(Consent Management Domain Organization | Consent Management Domain Research Study) |
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdQuestionnaire.jurisdiction Short description Intended jurisdiction for questionnaire (if applicable) Definition A legal or geographic region in which the questionnaire is intended to be used.
Comments It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Definition.jurisdiction
- rim:N/A (to add?)
|
purpose | S | 0..1 | markdown | Element IdShort description Zweckbeschreibung des Consent Modules Definition Explanation of why this questionnaire is needed and why it has been designed as it has.
Comments This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.purpose
- w5:FiveWs.why[x]
- rim:.reasonCode.text
- objimpl:no-gen-base
|
copyright | | 0..1 | markdown | There are no (further) constraints on this element Element IdShort description Use and/or publishing restrictions Alternate names License, Restrictions Definition A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
Requirements Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.
Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.copyright
- rim:N/A (to add?)
- objimpl:no-gen-base
|
approvalDate | | 0..1 | date | There are no (further) constraints on this element Element IdQuestionnaire.approvalDate Short description When the questionnaire was approved by publisher Definition The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Comments The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Data Type date Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.approvalDate
- rim:.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
- objimpl:no-gen-base
|
lastReviewDate | | 0..1 | date | There are no (further) constraints on this element Element IdQuestionnaire.lastReviewDate Short description When the questionnaire was last reviewed Definition The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Requirements Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
Comments If specified, this date follows the original approval date.
Data Type date Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Definition.lastReviewDate
- rim:.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
- objimpl:no-gen-base
|
effectivePeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdQuestionnaire.effectivePeriod Short description When the questionnaire is expected to be used Definition The period during which the questionnaire content was or is planned to be in active use.
Requirements Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.
Comments The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- workflow:Definition.effectivePeriod
- rim:N/A (to add?)
- objimpl:no-gen-base
|
code | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdShort description Concept that represents the overall questionnaire Definition An identifier for this question or group of questions in a particular terminology such as LOINC.
Requirements Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.
Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
Data Type Coding Binding Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.code
|
item | S I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdShort description Questions and sections within the Questionnaire Definition A particular question, question grouping or display text that is part of the questionnaire.
Comments The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - que-9:Read-only can't be specified for "display" items
type!='display' or readOnly.empty() - que-8:Initial values can't be specified for groups or display items
(type!='group' and type!='display') or initial.empty() - que-6:Required and repeat aren't permitted for display items
type!='display' or (required.empty() and repeats.empty()) - que-5:Only 'choice' and 'open-choice' items can have answerValueSet
(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) - que-4:A question cannot have both answerOption and answerValueSet
answerOption.empty() or answerValueSet.empty() - que-3:Display items cannot have a "code" asserted
type!='display' or code.empty() - que-10:Maximum length can only be declared for simple question types
(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() - que-1:Group items must have nested items, display items cannot have nested items
(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) - que-13:Can only have multiple initial values for repeating items
repeats=true or initial.count() <= 1 - que-11:If one or more answerOption is present, initial[x] must be missing
answerOption.empty() or initial.empty() - que-12:If there are more than one enableWhen, enableBehavior must be specified
enableWhen.count() > 2 implies enableBehavior.exists()
Mappings- rim:n/a
- rim:.outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
|
extension | I | 0..* | Extension | Element IdQuestionnaire.item.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
xacmlTemplate | S I | 0..* | Extension(Complex) | Element IdQuestionnaire.item.extension:xacmlTemplate Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension(Complex) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/XacmlTemplate Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
expression | I | 1..1 | Extension | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:expression Short description XACML-Ausdruck der Policy / des PolicySets Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:expression.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data Type System.String Fixed Value Mappings |
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:expression.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueBase64Binary | | | base64Binary | There are no (further) constraints on this element Data Type base64Binary |
label | I | 0..1 | Extension | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:label Short description Menschenlesbare Beschreibung der Policy / des PolicySets Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:label.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data Type System.String Fixed Value Mappings |
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.extension:label.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueString | | | string | There are no (further) constraints on this element Data Type string |
url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data Type System.String Fixed Value
http://fhir.de/ConsentManagement/StructureDefinition/XacmlTemplate Mappings |
value[x] | S | 0..0 | | There are no (further) constraints on this element Element IdQuestionnaire.item.extension:xacmlTemplate.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
designNote | S I | 0..1 | Extension(markdown) | Element IdQuestionnaire.item.extension:designNote Short description Design comments Alternate names extensions, user content Definition Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users.
Comments Allows capture of todos, rationale for design decisions, etc.
Data Type Extension(markdown) Extension URL http://hl7.org/fhir/StructureDefinition/designNote Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
linkId | S | 1..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.item.linkId Short description Unique id for item in questionnaire Definition An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
Requirements QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.
Comments This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
definition | | 0..1 | uri | There are no (further) constraints on this element Element IdQuestionnaire.item.definition Short description ElementDefinition - details for the item Definition This element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:
- code (ElementDefinition.code)
- type (ElementDefinition.type)
- required (ElementDefinition.min)
- repeats (ElementDefinition.max)
- maxLength (ElementDefinition.maxLength)
- answerValueSet (ElementDefinition.binding)
- options (ElementDefinition.binding).
Requirements A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.
Comments The uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:.outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
|
code | I | 0..* | Coding | There are no (further) constraints on this element Element IdShort description Corresponding concept for this item in a terminology Definition A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
Requirements Allows linking of groups of questions to formal terminologies.
Comments The value may come from the ElementDefinition referred to by .definition.
Data Type Coding Binding Codes for questionnaires, groups and individual questions. QuestionnaireQuestionCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.code
|
prefix | | 0..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.item.prefix Short description E.g. "1(a)", "2.5.3" Alternate names label Definition A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
Requirements Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.
Comments These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
text | S I | 0..1 | string | Element IdShort description Vollständiger Text des Moduls aus dem Einwilligungsdokument Definition The name of a section, the text of a question or text content for a display item.
Comments Hier wird der unformatierte Text abgelegt.
Zur formatierten Ablage kann die spezifizierte rendering-markdown-Extension verwendet werden.
In diesem Fall muss der reine Textinhalt identisch sein.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cm-1:Wenn der Text im Markdown-Format angegeben ist, muss er auch als Klartext angegeben sein.
extension('http://hl7.org/fhir/StructureDefinition/rendering-markdown').empty() or hasValue()
Mappings |
extension | I | 0..* | Extension | Element IdQuestionnaire.item.text.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
renderingMarkdown | I | 0..1 | Extension(markdown) | Element IdQuestionnaire.item.text.extension:renderingMarkdown Short description Text als Markdown Alternate names extensions, user content Definition This is an equivalent of the string on which the extension is sent, but includes additional markdown (see documentation about markdown. Note that using HTML xhtml can allow for greater precision of display.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension(markdown) Extension URL http://hl7.org/fhir/StructureDefinition/rendering-markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim:n/a
- rim:N/A
- rim:ED can be markdown content
|
url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingMarkdown.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data Type System.String Fixed Value
http://hl7.org/fhir/StructureDefinition/rendering-markdown Mappings |
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingMarkdown.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Sliced: Unordered, Open, by $this(Type) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueMarkdown | | 1..1 | markdown | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingMarkdown.value[x]:valueMarkdown Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
renderingXhtml | I | 0..1 | Extension(string) | Element IdQuestionnaire.item.text.extension:renderingXhtml Short description String equivalent with html markup Alternate names extensions, user content 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.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/rendering-xhtml Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim:n/a
- rim:N/A
- rim:ED can be XHTML content
|
url | | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingXhtml.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data Type System.String Fixed Value
http://hl7.org/fhir/StructureDefinition/rendering-xhtml Mappings |
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingXhtml.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Sliced: Unordered, Open, by $this(Type) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueString | | 1..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.item.text.extension:renderingXhtml.value[x]:valueString Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | S | 1..1 | codeBinding | There are no (further) constraints on this element Element IdShort description group | display | boolean | decimal | integer | date | dateTime + Definition The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
Requirements Defines the format in which the user is to be prompted for the answer.
Comments Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.
Data Type code Binding Distinguishes groups from questions and display text and indicates data type for questions. QuestionnaireItemType (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
enableWhen | ?! I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdQuestionnaire.item.enableWhen Short description Only allow data when Definition A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
Requirements Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.
Comments If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. treat "enableWhen"s as being joined by an "or" clause. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - que-7:If the operator is 'exists', the value must be a boolean
operator = 'exists' implies (answer is Boolean)
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
question | | 1..1 | string | There are no (further) constraints on this element Element IdQuestionnaire.item.enableWhen.question Short description Question that determines whether item is enabled Definition The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
Comments If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
operator | | 1..1 | codeBinding | There are no (further) constraints on this element Element IdQuestionnaire.item.enableWhen.operator Short description exists | = | != | > | < | >= | <= Definition Specifies the criteria by which the question is enabled.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type code Binding The criteria by which a question is enabled. QuestionnaireItemOperator (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
answer[x] | I | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.enableWhen.answer[x] Short description Value for question comparison based on operator Definition A value that the referenced question is tested using the specified operator in order for the item to be enabled.
Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
answerBoolean | | | boolean | There are no (further) constraints on this element Data Type boolean |
answerDecimal | | | decimal | There are no (further) constraints on this element Data Type decimal |
answerInteger | | | integer | There are no (further) constraints on this element Data Type integer |
answerDate | | | date | There are no (further) constraints on this element Data Type date |
answerDateTime | | | dateTime | There are no (further) constraints on this element Data Type dateTime |
answerTime | | | time | There are no (further) constraints on this element Data Type time |
answerString | | | string | There are no (further) constraints on this element Data Type string |
answerCoding | | | Coding | There are no (further) constraints on this element Data Type Coding |
answerQuantity | | | Quantity | There are no (further) constraints on this element Data Type Quantity |
answerReference | | | Reference(Resource) | There are no (further) constraints on this element Data Type Reference(Resource) |
enableBehavior | I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdQuestionnaire.item.enableBehavior Short description all | any Definition Controls how multiple enableWhen values are interpreted - whether all or any must be true.
Comments This element must be specified if more than one enableWhen value is provided.
Data Type code Binding Controls how multiple enableWhen values are interpreted - whether all or any must be true. EnableWhenBehavior (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
required | I | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.item.required Short description Whether the item must be included in data results Definition An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
Comments Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.
Meaning When Missing Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
repeats | I | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.item.repeats Short description Whether the item may repeat Definition An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.
Requirements Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.
Comments If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.
The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.
The value may come from the ElementDefinition referred to by .definition.
Meaning When Missing Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
readOnly | I | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.item.readOnly Short description Don't allow human editing Definition An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
Requirements Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.
Comments The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
maxLength | I | 0..1 | integer | There are no (further) constraints on this element Element IdQuestionnaire.item.maxLength Short description No more than this many characters Definition The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
Comments For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.
Data Type integer Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:N/A - MIF rather than RIM level
|
answerValueSet | I | 0..1 | canonical(ValueSet) | There are no (further) constraints on this element Element IdQuestionnaire.item.answerValueSet Short description Valueset containing permitted answers Definition A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
Comments LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.
Data Type canonical(ValueSet) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
answerOption | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdQuestionnaire.item.answerOption Short description Permitted answer Definition One of the permitted answers for a "choice" or "open-choice" question.
Comments This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.answerOption.value[x] Short description Answer value Definition A potential answer that's allowed as the answer to this question.
Comments The data type of the value must agree with the item.type.
Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
valueInteger | | | integer | There are no (further) constraints on this element Data Type integer |
valueDate | | | date | There are no (further) constraints on this element Data Type date |
valueTime | | | time | There are no (further) constraints on this element Data Type time |
valueString | | | string | There are no (further) constraints on this element Data Type string |
valueCoding | | | Coding | There are no (further) constraints on this element Data Type Coding |
valueReference | | | Reference(Resource) | There are no (further) constraints on this element Data Type Reference(Resource) |
initialSelected | | 0..1 | boolean | There are no (further) constraints on this element Element IdQuestionnaire.item.answerOption.initialSelected Short description Whether option is selected by default Definition Indicates whether the answer value is selected when the list of possible answers is initially shown.
Comments Use this instead of initial[v] if answerValueSet is present.
Meaning When Missing Only selected items explicitly marked to be selected
Data Type boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
initial | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdQuestionnaire.item.initial Short description Initial value(s) when item is first rendered Definition One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
Requirements In some workflows, having defaults saves time.
Comments The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
value[x] | | 1..1 | | There are no (further) constraints on this element Element IdQuestionnaire.item.initial.value[x] Short description Actual value for initializing the question Definition The actual value to for an initial answer.
Comments The type of the initial value must be consistent with the type of the item.
Binding Allowed values to answer questions. QuestionnaireAnswerCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:N/A - MIF rather than RIM level
|
valueBoolean | | | boolean | There are no (further) constraints on this element Data Type boolean |
valueDecimal | | | decimal | There are no (further) constraints on this element Data Type decimal |
valueInteger | | | integer | There are no (further) constraints on this element Data Type integer |
valueDate | | | date | There are no (further) constraints on this element Data Type date |
valueDateTime | | | dateTime | There are no (further) constraints on this element Data Type dateTime |
valueTime | | | time | There are no (further) constraints on this element Data Type time |
valueString | | | string | There are no (further) constraints on this element Data Type string |
valueUri | | | uri | There are no (further) constraints on this element Data Type uri |
valueAttachment | | | Attachment | There are no (further) constraints on this element Data Type Attachment |
valueCoding | | | Coding | There are no (further) constraints on this element Data Type Coding |
valueQuantity | | | Quantity | There are no (further) constraints on this element Data Type Quantity |
valueReference | | | Reference(Resource) | There are no (further) constraints on this element Data Type Reference(Resource) |
item | I | 0..0 | see (item) | There are no (further) constraints on this element Element IdShort description Nested questionnaire items Definition Text, questions and other groups to be nested beneath a question or group.
Requirements Reports can consist of complex nested groups.
Comments There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.
Mappings- rim:.outboundRelationship[typeCode=COMP].target
|