HL7.FHIR.UV.EXTENSIONS\QuestionnaireResponse Unit Option - Definitions

FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: QRUnitOption - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 3

Definitions for the questionnaire-unitOption extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	A unit that the user may choose when providing a quantity value.
Short	Unit choice
Comments	Provide either unitOption(s) or unitValueSet. If either of the extensions are present, the units for a Quantity element are constrained to only the units listed by the extensions - i.e. it is treated as a "required", not an "extensible" binding. In the absence of either, any unit is valid. See additional guidance and examples in the SDC implementation guide. If this extension present and an answer is provided for the question item in the QuestionnaireResponse, then the valueQuantity SHALL have a Quantity.code and Quantity.system that match the Coding.code and system of one of the allowed values if the Coding has a code and/or system. If the Coding only has a display, then the Quantity.unit must match. (Note that Coding with only a display is strongly discouraged.) If there is a match on code and system, but no match on display/unit, systems MAY raise a warning. However, because of translation and bandwidth considerations, some systems MAY opt to drop the unit or express it in an alternate language.
Control	0..*
2. Extension.extension
Control	0..0
4. Extension.url
Fixed Value	`http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption`
6. Extension.value[x]
Control	1..?
Type	Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	A unit that the user may choose when providing a quantity value. Optional Extension Element - found in all resources.
Short	Unit choiceOptional Extensions Element
Comments	Provide either unitOption(s) or unitValueSet. If either of the extensions are present, the units for a Quantity element are constrained to only the units listed by the extensions - i.e. it is treated as a "required", not an "extensible" binding. In the absence of either, any unit is valid. See additional guidance and examples in the SDC implementation guide. If this extension present and an answer is provided for the question item in the QuestionnaireResponse, then the valueQuantity SHALL have a Quantity.code and Quantity.system that match the Coding.code and system of one of the allowed values if the Coding has a code and/or system. If the Coding only has a display, then the Quantity.unit must match. (Note that Coding with only a display is strongly discouraged.) If there is a match on code and system, but no match on display/unit, systems MAY raise a warning. However, because of translation and bandwidth considerations, some systems MAY opt to drop the unit or express it in an alternate language.
Control	0..*
Is Modifier	false
Invariants	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())
2. Extension.extension
Definition	An Extension 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 managable, 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.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	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())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption`
6. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1 This element is affected by the following invariants: ext-1
Type	Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	A unit that the user may choose when providing a quantity value.
Short	Unit choice
Comments	Provide either unitOption(s) or unitValueSet. If either of the extensions are present, the units for a Quantity element are constrained to only the units listed by the extensions - i.e. it is treated as a "required", not an "extensible" binding. In the absence of either, any unit is valid. See additional guidance and examples in the SDC implementation guide. If this extension present and an answer is provided for the question item in the QuestionnaireResponse, then the valueQuantity SHALL have a Quantity.code and Quantity.system that match the Coding.code and system of one of the allowed values if the Coding has a code and/or system. If the Coding only has a display, then the Quantity.unit must match. (Note that Coding with only a display is strongly discouraged.) If there is a match on code and system, but no match on display/unit, systems MAY raise a warning. However, because of translation and bandwidth considerations, some systems MAY opt to drop the unit or express it in an alternate language.
Control	0..*
Is Modifier	false
Invariants	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()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1 This element is affected by the following invariants: ele-1
Type	id
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	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()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption`
8. Extension.value[x]
Definition	Changed: Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1 This element is affected by the following invariants: ext-1
Type	Coding
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.extensions#5.2.0-ballot based on FHIR 5.0.0. Generated 2024-10-09
Links: Table of Contents | QA Report | Version History | | Propose a change