Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the cpg-preferenceBehavior extension
See the documentation on how to interpret the contents of this table
| 0. Extension | |
| Definition | Conveys the CPG's stance or preference disposition toward a particular option: supplemental information that helps the clinician interpret the recommendation and weigh it against alternatives. It does not explain why the option was surfaced (that is the concern of rationale and provenance). It conveys how the CPG regards the option once surfaced: is it preferred among the available options, simply recommended, neutral (allowable, no position taken), or not recommended for this patient? Authored on PlanDefinition.action to convey the CPG's intended stance for an action at design time, and realized on the corresponding RequestGroup.action by the $apply operation. Applicability is expressed through an action condition of kind Optional Extension Element - found in all resources. |
| Short | CPG Preference Behavior ExtensionOptional Extensions Element |
| Comments | Applicability determines whether an action is included at all; preference describes how the CPG regards the action once included. Preference behavior SHALL NOT be used to express or override applicability. A |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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())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. |
| 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 are Unordered and Open, and can be differentiated using the following discriminators:
|
| 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 | |
| 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 | 0..1 |
| Binding | The codes SHALL be taken from For codes, see CPG Preference Behavior Value Set (required to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-preference-behavior-vs)How the CPG regards an option once surfaced |
| Type | 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 | 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())) |
See the documentation on how to interpret the contents of this table
| 0. Extension | |
| Definition | Conveys the CPG's stance or preference disposition toward a particular option: supplemental information that helps the clinician interpret the recommendation and weigh it against alternatives. It does not explain why the option was surfaced (that is the concern of rationale and provenance). It conveys how the CPG regards the option once surfaced: is it preferred among the available options, simply recommended, neutral (allowable, no position taken), or not recommended for this patient? Authored on PlanDefinition.action to convey the CPG's intended stance for an action at design time, and realized on the corresponding RequestGroup.action by the $apply operation. Applicability is expressed through an action condition of kind |
| Short | CPG Preference Behavior Extension |
| Comments | Applicability determines whether an action is included at all; preference describes how the CPG regards the action once included. Preference behavior SHALL NOT be used to express or override applicability. A |
| 2. Extension.extension | |
| Control | 0..0 |
| 4. Extension.url | |
| Fixed Value | |
| 6. Extension.value[x] | |
| Binding | The codes SHALL be taken from CPG Preference Behavior Value Set (required to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-preference-behavior-vs)How the CPG regards an option once surfaced |
| Type | 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 | SeeChoice of Data Typesfor further information about how to use [x] |
See the documentation on how to interpret the contents of this table
| 0. Extension | |
| Definition | Conveys the CPG's stance or preference disposition toward a particular option: supplemental information that helps the clinician interpret the recommendation and weigh it against alternatives. It does not explain why the option was surfaced (that is the concern of rationale and provenance). It conveys how the CPG regards the option once surfaced: is it preferred among the available options, simply recommended, neutral (allowable, no position taken), or not recommended for this patient? Authored on PlanDefinition.action to convey the CPG's intended stance for an action at design time, and realized on the corresponding RequestGroup.action by the $apply operation. Applicability is expressed through an action condition of kind |
| Short | CPG Preference Behavior Extension |
| Comments | Applicability determines whether an action is included at all; preference describes how the CPG regards the action once included. Preference behavior SHALL NOT be used to express or override applicability. A |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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 |
| Type | string |
| 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 are Unordered and Open, and can be differentiated using the following discriminators:
|
| 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 | |
| 8. 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 | 0..1 |
| Binding | The codes SHALL be taken from CPG Preference Behavior Value Set (required to http://hl7.org/fhir/uv/cpg/ValueSet/cpg-preference-behavior-vs)How the CPG regards an option once surfaced |
| Type | CodeableConcept |
| [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())) |