ValueSet
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in coded elements.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/ValueSet| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/ValueSet/[id] |
| Vread | GET | /fhir/R5/ValueSet/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/ValueSet/[id] |
| Patch | PATCH | /fhir/R5/ValueSet/[id] |
| Delete | DELETE | /fhir/R5/ValueSet/[id] |
| Create | POST | /fhir/R5/ValueSet |
| Search | GET | /fhir/R5/ValueSet?... |
| History | GET | /fhir/R5/ValueSet/[id]/_history |
| Type-history | GET | /fhir/R5/ValueSet/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this value set, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the value set (business identifier) |
version | string | 0..1 | Business version of the value set |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 0..1 | Name for this value set (computer friendly) |
title | string | 0..1 | Name for this value set (human friendly) |
status | code | 1..1 | draft |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher/steward (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the value set |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for value set (if applicable) |
immutable | boolean | 0..1 | Indicates whether or not any change to the content logical definition may occur |
purpose | markdown | 0..1 | Why this value set is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
approvalDate | date | 0..1 | When the ValueSet was approved by publisher |
lastReviewDate | date | 0..1 | When the ValueSet was last reviewed by the publisher |
effectivePeriod | Period | 0..1 | When the ValueSet is expected to be used |
topic | CodeableConcept | 0..* | E.g. Education, Treatment, Assessment, etc |
author | ContactDetail | 0..* | Who authored the ValueSet |
editor | ContactDetail | 0..* | Who edited the ValueSet |
reviewer | ContactDetail | 0..* | Who reviewed the ValueSet |
endorser | ContactDetail | 0..* | Who endorsed the ValueSet |
relatedArtifact | RelatedArtifact | 0..* | Additional documentation, citations, etc |
compose | BackboneElement | 0..1 | Content logical definition of the value set (CLD) |
expansion | BackboneElement | 0..1 | Used when the value set is "expanded" |
scope | BackboneElement | 0..1 | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource |
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
derived-from | reference | What resource is being referenced |
description | string | The description of the activity definition |
effective | date | The time during which the activity definition is intended to be in use |
expansion | uri | Identifies the value set expansion (business identifier) |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
name | string | Computationally friendly name of the activity definition |
predecessor | reference | What resource is being referenced |
publisher | string | Name of the publisher of the activity definition |
reference | uri | A code system included or excluded in the value set or an imported value set |
status | token | The current status of the activity definition |
title | string | The human-friendly name of the activity definition |
topic | token | Topics associated with the module |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
ValueSet - Maturity: Normative (FMM 5).