ExecutableValueSet
Executable ValueSet
draftResource131 elementsv5.0.0
Defines an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an executable value set, a computable definition of the value set must be obtained to compute the updated expansion.
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/executablevalueset
- ID
- executablevalueset
- Type
- Base Definition
- Derivation
- constraint
- Publisher
- HL7
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
ValueSet | 1..1 | A set of codes drawn from one or more code systems | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | 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 contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Extension | |
extension | 0..* | narrative | semi-structured | structured | executable | |
extension | 0..1 | Reference to the current trusted source of the ValueSet resource (metadata and definition) | |
extension | 1..1 | Extra warning about the correct use of the value set | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
url | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | 0..* | Additional identifier for the value set (business identifier) | |
version | 1..1 | string | Business version of the value set |
versionAlgorithm[x] | 0..1 | stringCoding | How to compare versionsextensible: version-algorithm |
name | 0..1 | string | Name for this value set (computer friendly) |
title | 1..1 | string | Name for this value set (human friendly) |
status | 1..1 | code | draft | active | retired | unknownrequired: publication-status |
experimental | 1..1 | boolean | For testing purposes, not real usage |
date | 0..1 | dateTime | Date last changed |
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | 0..* | Contact details for the publisher | |
description | 1..1 | markdown | Natural language description of the value set |
useContext | 0..* | The context that the content is intended to support | |
jurisdiction | 0..* | Intended jurisdiction for value set (if applicable)extensible: jurisdiction | |
immutable | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
purpose | 0..1 | markdown | Why this value set is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the ValueSet was approved by publisher |
lastReviewDate | 0..1 | date | When the ValueSet was last reviewed by the publisher |
effectivePeriod | 0..1 | When the ValueSet is expected to be used | |
topic | 0..* | E.g. Education, Treatment, Assessment, etcexample: definition-topic | |
author | 0..* | Who authored the ValueSet | |
editor | 0..* | Who edited the ValueSet | |
reviewer | 0..* | Who reviewed the ValueSet | |
endorser | 0..* | Who endorsed the ValueSet | |
relatedArtifact | 0..* | Additional documentation, citations, etc | |
compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
expansion | 1..1 | BackboneElement | Used when the value set is "expanded" |
scope | 0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description |