This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Example | id | Format | |
---|---|---|---|
Common Persona Value Set | cpg-common-persona | XML | JSON |
Common Process Value Set | cpg-common-process | XML | JSON |
Indicator Value Set | cpg-indicator | XML | JSON |
recommendation-direction Value Set | cpg-recommendation-direction | XML | JSON |
Example of an expression-based value set | opioids-with-ambulatory-abuse-potential | XML | JSON |
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-valueset
Profile of ValueSet for use with CPG Implementation Guide
This profile builds on Shareable ValueSet.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 2 elements
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | A set of codes drawn from one or more code systems | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-approvalDate | SI | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
valueset-effectiveDate | SI | 0..1 | dateTime | When the value set version becomes Active and is available for use URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate |
valueset-expirationDate | SI | 0..1 | date | When the value set version should no longer be used URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate |
resource-lastReviewDate | SI | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
valueset-author | SI | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-keyWord | SI | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord |
valueset-sourceReference | I | 0..* | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | SΣ | 1..1 | string | Business version of the value set |
name | SΣI | 1..1 | string | Name for this value set (computer friendly) |
title | SΣ | 1..1 | string | Name for this value set (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 1..1 | markdown | Natural language description of the value set |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | S | 0..1 | markdown | Why this value set is defined |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
compose | SI | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter vsd-1: A value set include/exclude SHALL have a value set or a system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
use | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | Σ | 1..1 | code | A property/filter defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | Name as assigned by the client or server | |
value[x] | 0..1 | Value of the named parameter | ||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
Summary
Mandatory: 2 elements
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | I | 1..1 | A set of codes drawn from one or more code systems | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
resource-approvalDate | SI | 0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate |
valueset-effectiveDate | SI | 0..1 | dateTime | When the value set version becomes Active and is available for use URL: http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate |
valueset-expirationDate | SI | 0..1 | date | When the value set version should no longer be used URL: http://hl7.org/fhir/StructureDefinition/valueset-expirationDate |
resource-lastReviewDate | SI | 0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate |
valueset-author | SI | 0..* | ContactDetail | Entity/entities that create and may modify the Value Set URL: http://hl7.org/fhir/StructureDefinition/valueset-author |
valueset-keyWord | SI | 0..* | string | Descriptors and key terms for search URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord |
valueset-sourceReference | I | 0..* | uri | Where did this content come from URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | SΣ | 0..* | Identifier | Additional identifier for the value set (business identifier) |
version | SΣ | 1..1 | string | Business version of the value set |
name | SΣI | 1..1 | string | Name for this value set (computer friendly) |
title | SΣ | 1..1 | string | Name for this value set (human friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
date | SΣ | 1..1 | dateTime | Date last changed |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) |
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
description | S | 1..1 | markdown | Natural language description of the value set |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | S | 0..1 | markdown | Why this value set is defined |
copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
compose | SI | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
lockedDate | Σ | 0..1 | date | Fixed date for references with no specified version (transitive) |
inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
include | ΣI | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter vsd-1: A value set include/exclude SHALL have a value set or a system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | ΣI | 0..1 | uri | The system the codes come from |
version | Σ | 0..1 | string | Specific version of the code system referred to |
concept | I | 0..* | BackboneElement | A concept defined in the system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Code or expression from system | |
display | 0..1 | string | Text to display for this code for this value set in this valueset | |
designation | I | 0..* | BackboneElement | Additional representations for this concept |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
language | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
use | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible) | |
value | 1..1 | string | The text value for this designation | |
filter | ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | Σ | 1..1 | code | A property/filter defined by the code system |
op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
value | Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSet | ΣI | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
expansion | I | 0..1 | BackboneElement | Used when the value set is "expanded" |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) | |
timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
total | 0..1 | integer | Total number of codes in the expansion | |
offset | 0..1 | integer | Offset at which this resource starts | |
parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | 1..1 | string | Name as assigned by the client or server | |
value[x] | 0..1 | Value of the named parameter | ||
valueString | string | |||
valueBoolean | boolean | |||
valueInteger | integer | |||
valueDecimal | decimal | |||
valueUri | uri | |||
valueCode | code | |||
valueDateTime | dateTime | |||
contains | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
system | 0..1 | uri | System value for the code | |
abstract | 0..1 | boolean | If user cannot select this entry | |
inactive | 0..1 | boolean | If concept is inactive in the code system | |
version | 0..1 | string | Version in which this code/display is defined | |
code | I | 0..1 | code | Code - if blank, this is not a selectable code |
display | I | 0..1 | string | User display for the concept |
designation | 0..* | Unknown reference to #ValueSet.compose.include.concept.designation Additional representations for this item | ||
contains | 0..* | Unknown reference to #ValueSet.expansion.contains Codes contained under this entry | ||
Documentation for this format |
Path | Conformance | ValueSet |
ValueSet.language | preferred | CommonLanguages Max Binding: AllLanguages |
ValueSet.status | required | PublicationStatus |
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet |
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages Max Binding: AllLanguages |
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse |
ValueSet.compose.include.filter.op | required | FilterOperator |
Id | Path | Details | Requirements |
dom-2 | ValueSet | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | ValueSet | 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 | ValueSet | 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 | ValueSet | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | ValueSet | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
vsd-0 | ValueSet | 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}') | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | ValueSet.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ValueSet.compose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists() | |
vsd-3 | ValueSet.compose.include | Cannot have both concept and filter : concept.empty() or filter.empty() | |
vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists() | |
ele-1 | ValueSet.compose.include.concept | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.concept.designation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.compose.include.filter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | ValueSet.expansion.contains | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present : code.empty() or system.exists() |