HL7.FHIR.US.DAVINCI-VBPR\Threshold - Definitions

This page is part of the Da Vinci Value-Based Performance Reporting Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Extension: Threshold - Detailed Descriptions

Active as of 2023-07-31

Definitions for the threshold extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. Extension
Definition	The Threshold Extension is a complex extension that defines a threshold needed to be met when measuring performance. Optional Extension Element - found in all resources.
2. Extension.extension
Control	20..*
3. Extension.extension:threshold
SliceName	threshold
Definition	The threshold percentile
Control	1..1
Must Support	true
4. Extension.extension:threshold.extension
Control	0..0
5. Extension.extension:threshold.url
Control	0..?
Fixed Value	threshold
6. Extension.extension:threshold.value[x]
Control	1..?
Type	Choice of: decimal, Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
7. Extension.extension:type
SliceName	type
Definition	The type or the name of the threshold, such as star-2 threshold in star rating
Control	1..1
Must Support	true
8. Extension.extension:type.extension
Control	0..0
9. Extension.extension:type.url
Control	0..?
Fixed Value	type
10. Extension.extension:type.value[x]
Control	1..?
Binding	The codes SHALL be taken from Threshold Type; other codes may be used where these codes are not suitable
Type	CodeableConcept
[x] Note	See Choice of Data Types for further information about how to use [x]
11. Extension.extension:gapToThreshold
SliceName	gapToThreshold
Definition	Gap to achieve the threshold
Control	0..1
Must Support	true
12. Extension.extension:gapToThreshold.extension
Control	0..0
13. Extension.extension:gapToThreshold.url
Control	0..?
Fixed Value	gapToThreshold
14. Extension.extension:gapToThreshold.value[x]
Control	1..?
Type	Choice of: decimal, Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
15. Extension.url
Fixed Value	http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/threshold
16. Extension.value[x]
Control	0..01
[x] Note	See Choice of Data Types for further information about how to use [x]

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

1. Extension
Definition	The Threshold Extension is a complex extension that defines a threshold needed to be met when measuring performance. Optional Extension Element - found in all resources.
Control	0..* This element is affected by the following invariants: ele-1
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	20..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
3. Extension.extension:threshold
SliceName	threshold
Definition	The threshold percentile May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	10..1*
Type	Extension
Must Support	true
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. Extension.extension:threshold.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
5. Extension.extension:threshold.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	threshold
6. Extension.extension:threshold.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Type	Choice of: decimal, Quantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Extension.extension:type
SliceName	type
Definition	The type or the name of the threshold, such as star-2 threshold in star rating May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	10..1*
Type	Extension
Must Support	true
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. Extension.extension:type.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. Extension.extension:type.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	type
10. Extension.extension:type.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Binding	The codes SHALL be taken from Threshold Type; other codes may be used where these codes are not suitableFor codes, see (unbound)
Type	Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Extension.extension:gapToThreshold
SliceName	gapToThreshold
Definition	Gap to achieve the threshold May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..1*
Type	Extension
Must Support	true
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Extension.extension:gapToThreshold.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
13. Extension.extension:gapToThreshold.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	gapToThreshold
14. Extension.extension:gapToThreshold.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Type	Choice of: decimal, Quantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/threshold
16. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	0..01
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element 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.

1. Extension
Definition	The Threshold Extension is a complex extension that defines a threshold needed to be met when measuring performance.
Control	0..* This element is affected by the following invariants: ele-1
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
3. Extension.extension
Definition	An Extension
Control	2..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:threshold
SliceName	threshold
Definition	The threshold percentile
Control	1..1
Type	Extension
Must Support	true
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Extension.extension:threshold.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
6. Extension.extension:threshold.extension
Definition	An Extension
Control	0..0
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
7. Extension.extension:threshold.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	threshold
8. Extension.extension:threshold.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	Choice of: decimal, Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.extension:type
SliceName	type
Definition	The type or the name of the threshold, such as star-2 threshold in star rating
Control	1..1
Type	Extension
Must Support	true
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Extension.extension:type.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
11. Extension.extension:type.extension
Definition	An Extension
Control	0..0
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:type.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	type
13. Extension.extension:type.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Binding	The codes SHALL be taken from Threshold Type; other codes may be used where these codes are not suitable
Type	CodeableConcept
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Extension.extension:gapToThreshold
SliceName	gapToThreshold
Definition	Gap to achieve the threshold
Control	0..1
Type	Extension
Must Support	true
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Extension.extension:gapToThreshold.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
16. Extension.extension:gapToThreshold.extension
Definition	An Extension
Control	0..0
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
17. Extension.extension:gapToThreshold.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	gapToThreshold
18. Extension.extension:gapToThreshold.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	Choice of: decimal, Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/threshold
20. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	0..0
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))