| ConsentTemplate (Questionnaire) | I | | Consent Management Template Frame | 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.
Consent Management Template Frame 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}')
- rim: Entity. Role, or Act
- workflow: Definition
- rim: Observation[moodCode=DEF]
|
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The 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.
string |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.implicitRules A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | S | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Sprache des Moduls Definition The 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).
code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
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.
Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort 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 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| sourceDocument | S I | 0..* | Extension(Attachment) | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(Attachment) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/SourceDocument 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://fhir.de/ConsentManagement/StructureDefinition/SourceDocument |
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueAttachment | | | Attachment | There are no (further) constraints on this element Data type Attachment |
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| contentType | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].contentType Mime type of the content, with charset etc. Definition Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Processors of the data need to be able to know how to interpret the data.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding The mime type of an attachment. Any valid mime type is allowed.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generaltext/plain; charset=UTF-8, image/png
Mappings- rim: n/a
- v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
- rim: ./mediaType, ./charset
|
| language | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].language Human language of the content (BCP-47) Definition The human language of the content. The value can be any valid value according to BCP 47.
Users need to be able to choose between the languages in a set of attachments.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| data | S | 1..1 | base64Binary | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].data Data inline, base64ed Definition The actual data of the attachment - a sequence of bytes, base64 encoded.
The data needs to able to be transmitted inline.
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
base64Binary Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: ED.5
- rim: ./data
|
| url | Σ | 0..1 | url | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].url Uri where the data can be found Definition A location where the data can be accessed.
The data needs to be transmitted by reference.
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/logo-small.png
Mappings- rim: n/a
- v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
- rim: ./reference/literal
|
| size | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].size Number of bytes of content (if url provided) Definition The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
unsignedInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A (needs data type R3 proposal)
|
| hash | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].hash Hash of the data (sha-1, base64ed) Definition The calculated hash of the data using SHA-1. Represented using base64.
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
base64Binary Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
|
| title | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].title Label to display in place of the data Definition A label or set of text to display in place of the data.
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
GeneralOfficial Corporate Logo
Mappings- rim: n/a
- rim: ./title/data
|
| creation | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idQuestionnaire.extension:sourceDocument.value[x].creation Date attachment was first created Definition The date that the attachment was first created.
This is often tracked as an integrity issue for use of the attachment.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A (needs data type R3 proposal)
|
| signatureRequired | S I | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired Is signature needed? Alternate names extensions, user content Definition Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse.
If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.)
The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension.
Extension(CodeableConcept) Extension URL http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The type of signature needed.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data type CodeableConcept |
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].coding Code defined by a terminology system Definition A 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.
Coding Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].coding.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].coding.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].coding.system Identity of the terminology system Definition The 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.extension:signatureRequired.value[x].coding.version 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.extension:signatureRequired.value[x].coding.code 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.extension:signatureRequired.value[x].coding.display Representation defined by the system Definition A 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
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.extension:signatureRequired.value[x].coding.userSelected 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).
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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 ]
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:signatureRequired.value[x].text Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| created | S I | 0..1 | Extension(instant) | Element idQuestionnaire.extension:created Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(instant) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/Created 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()
|
| externalProperty | S I | 0..* | Extension(Complex) | Element idQuestionnaire.extension:externalProperty ExternalProperty Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty 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()
|
| expirationProperty | S I | 0..* | Extension(Complex) | Element idQuestionnaire.extension:expirationProperty Expiration Property Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty 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()
|
| label | S I | 0..1 | Extension(string) | Element idQuestionnaire.extension:label Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(string) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/QuestionnaireLabel 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()
|
| versionLabel | S I | 0..1 | Extension(string) | Element idQuestionnaire.extension:versionLabel Versions-Label Alternate names extensions, user content Definition 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.
Extension(string) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/VersionLabel 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.extension:versionLabel.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension:versionLabel.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.extension:versionLabel.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value https://ths-greifswald.de/fhir/StructureDefinition/gics/VersionLabel |
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.extension:versionLabel.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueString | | | string | There are no (further) constraints on this element Data type string |
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.modifierExtension Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idShort description Kanonischer, global eindeutiger Name ("Canonical identifier") des Templates Frames Definition Kanonischer, global eindeutiger Name ("Canonical identifier") des Templates Frames. Wird benötigt zur Rückreferenzierung aus dem QuestionnaireComposed.
… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.
Beispiel: http://meine-klinik.de/fhir/NamingSystem/ProjektX/FragebogenTemplate12
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.url
- w5: FiveWs.identifier
- rim: .identifier[scope=BUSN;reliability=ISS]
|
| identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idShort description Identifikator eines Template-Frames Definition Identifikator eines Moduls. Dient dem Zweck des systemübergreifen Identifizierens, z.B. beim verteilten Consent Management
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.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.identifier.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.identifier.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known .
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
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 Time period when id is/was valid for use Definition Time 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.
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)
- 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 Organization that issued id (may be just text) Definition Organization 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.
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'))
- 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 | There are no (further) constraints on this element Element idShort description Versionsangabe des Template Frames 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.
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].
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.version
- w5: FiveWs.version
- rim: N/A (to add?)
|
| name | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idShort description Name des Template Frames 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| title | S Σ | 0..1 | string | There are no (further) constraints on this element Element idShort description Anzuzeigender Kurztitel der Einwilligung Definition Titel des Consent Moduls zur Darstellung auf dem späteren Consent Template
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.title
- rim: .title
|
| derivedFrom | | 0..* | canonical(Questionnaire) | There are no (further) constraints on this element Element idQuestionnaire.derivedFrom Instantiates protocol or definition Definition The URL of a Questionnaire that this Questionnaire is based on.
Allows a Questionnaire to be created based on another Questionnaire.
canonical(Questionnaire) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.
Allows filtering of questionnaires that are appropriate for use versus not.
code Binding The lifecycle status of an artifact.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 Resource that can be subject of QuestionnaireResponse Definition The types of subjects that can be the subject of responses created for the questionnaire.
If none are specified, then the subject is unlimited.
code Binding One of the resource types defined as part of this version of FHIR.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.
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.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.publisher
- w5: FiveWs.witness
- rim: .participation[typeCode=AUT].role
|
| contact | S Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idShort description Ansprechpartner Definition Inhaltlicher Ansprechpartner der auf der Einwilligungsvorlage angezeigt werden soll
May be a web site, an email address, a telephone number, etc.
ContactDetail Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.contact
- rim: .participation[typeCode=CALLBCK].role
|
| description | S | 0..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.description Zweckbeschreibung des Consent Modules Definition A 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).
markdown Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.
Assist in searching for appropriate content.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
UsageContext Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Definition.useContext
- rim: N/A (to add?)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| code | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.useContext.code Type of context being specified Definition A code that identifies the type of context being specified by this usage context.
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.
Coding Binding A code that specifies a type of context being specified by a usage context.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext.code.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext.code.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.useContext.code.system Identity of the terminology system Definition The 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 Representation defined by the system Definition A 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
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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).
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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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] 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.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext.value[x].id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext.value[x].extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext.value[x].reference 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idQuestionnaire.useContext.value[x].type 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idQuestionnaire.useContext.value[x].identifier 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.
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).
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueReference | | | Reference(Consent Management Domain Research Study) | Data type Reference(Consent Management Domain Research Study) |
| jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idQuestionnaire.jurisdiction Intended jurisdiction for questionnaire (if applicable) Definition A 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.
CodeableConcept Binding Countries and regions within which this artifact is targeted for use.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | | 0..1 | markdown | There are no (further) constraints on this element Element idShort description Why this questionnaire is defined Definition Explanation 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.
markdown Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.
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/
markdown Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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.
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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.
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)
- 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 | S Σ | 1..1 | CodingBinding | 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.
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.
Coding Binding Codes for questionnaires, groups and individual questions.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.code.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.code.system Identity of the terminology system Definition The 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.code.version 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idShort 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.code.display Representation defined by the system Definition A 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
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.code.userSelected 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).
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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 ]
|
| item | S I | 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.
The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
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()
- rim: n/a
- rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| designNote | S I | 0..1 | Extension(markdown) | There are no (further) constraints on this element Element idQuestionnaire.item.extension:designNote 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.
Allows capture of todos, rationale for design decisions, etc.
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()
|
| subQuestionnaire | S I | 0..1 | Extension(Reference(Consent Management Template Module)) | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(Reference(Consent Management Template Module)) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/SubQuestionnaire 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://fhir.de/ConsentManagement/StructureDefinition/SubQuestionnaire |
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].reference 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].type 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].identifier 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.
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).
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.extension:subQuestionnaire.value[x].display Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueReference | | | Reference(Consent Management Template Module | ConsentModule) | Data type Reference(Consent Management Template Module | ConsentModule) |
| externalProperty | S I | 0..* | Extension(Complex) | Element idQuestionnaire.item.extension:externalProperty ExternalProperty Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty 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()
|
| expirationProperty | S I | 0..* | Extension(Complex) | Element idQuestionnaire.item.extension:expirationProperty Expiration Property Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExpirationProperty 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()
|
| freeTextDefAttributes | S I | 0..1 | Extension(Complex) | Element idQuestionnaire.item.extension:freeTextDefAttributes ExternalProperty Alternate names extensions, user content Definition 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.
Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/FreeTextDefAttributes 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()
|
| position | S I | 0..1 | Extension(integer) | Element idQuestionnaire.item.extension:position Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(integer) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/Position 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()
|
| 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 names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.
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()
|
| linkId | S | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.linkId 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| definition | | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.item.definition 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).
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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
|
| code | S 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).
Allows linking of groups of questions to formal terminologies.
The value may come from the ElementDefinition referred to by .definition.
Coding Binding Codes for questionnaires, groups and individual questions.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.code.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.item.code.system Identity of the terminology system Definition The 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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.item.code.version 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.code.code 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).
Need to refer to a particular code in the system.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.item.code.display Representation defined by the system Definition A 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
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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.item.code.userSelected 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).
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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 ]
|
| prefix | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.prefix 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: Not supported
|
| text | S | 0..1 | string | There are no (further) constraints on this element Element idShort description Primary text for the item Definition The 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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.text.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| renderingMarkdown | I | 0..1 | Extension(markdown) | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown String equivalent with 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.
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.
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()
- rim: n/a
- rim: N/A
- rim: ED can be markdown content
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://hl7.org/fhir/StructureDefinition/rendering-markdown |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueMarkdown | | 1..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingMarkdown.value[x]:valueMarkdown Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
markdown Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| renderingXhtml | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml 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.
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.
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()
- rim: n/a
- rim: N/A
- rim: ED can be XHTML content
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://hl7.org/fhir/StructureDefinition/rendering-xhtml |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueString | | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.text.extension:renderingXhtml.value[x]:valueString Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idQuestionnaire.item.text.value Primitive value for string Definition Primitive value for string
System.String Maximum string length |
| 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.).
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.
code Binding Distinguishes groups from questions and display text and indicates data type for questions.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| enableWhen | S ?! I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen 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.
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.
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)
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| sourceSubQuestionnaire | S I | 0..1 | Extension(Reference(Consent Management Template Module)) | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources.
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.
Extension(Reference(Consent Management Template Module)) Extension URL http://fhir.de/ConsentManagement/StructureDefinition/SubQuestionnaire 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.url identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
uri Fixed value http://fhir.de/ConsentManagement/StructureDefinition/SubQuestionnaire |
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x] Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].reference 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].type 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].identifier 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.
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).
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extension:sourceSubQuestionnaire.value[x].display Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| valueReference | | | Reference(Consent Management Template Module) | There are no (further) constraints on this element Data type Reference(Consent Management Template Module) |
| 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 names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.
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()
|
| question | S | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.question 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.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| operator | S | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.operator exists | = | != | > | < | >= | <= Definition Specifies the criteria by which the question is enabled.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding The criteria by which a question is enabled.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| answer[x] | S I | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.answer[x] 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.
Allowed values to answer questions.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 all | any Definition Controls 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.
code Binding Controls how multiple enableWhen values are interpreted - whether all or any must be true.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| required | S 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 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.
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
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 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.
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
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 Don't allow human editing Definition An 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.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 No more than this many characters Definition The 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.
integer Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: N/A
- rim: N/A - MIF rather than RIM level
|
| answerValueSet | S I | 0..1 | canonical(ValueSet) | There are no (further) constraints on this element Element idQuestionnaire.item.answerValueSet 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.
LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition.
canonical(ValueSet) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| answerOption | S I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption Permitted answer Definition One 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.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| 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 names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.
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()
|
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.value[x] Answer value Definition A 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.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | S | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.initialSelected Whether option is selected by default Definition Indicates 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
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| initial | S I | 0..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.initial 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.
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.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A - MIF rather than RIM level
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.initial.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.initial.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| 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 names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.
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()
|
| value[x] | S | 1..1 | | There are no (further) constraints on this element Element idQuestionnaire.item.initial.value[x] Actual value for initializing the question Definition The 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.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | S I | 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.
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.
- rim: .outboundRelationship[typeCode=COMP].target
|
