ValueSet

Normative Terminology

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

alphahttps://api.dev.ovok.com/fhir/R4/ValueSet

Interaction	Method	Path
Read	GET	/fhir/R4/ValueSet/[id]
Vread	GET	/fhir/R4/ValueSet/[id]/_history/[vid]
Update	PUT	/fhir/R4/ValueSet/[id]
Patch	PATCH	/fhir/R4/ValueSet/[id]
Delete	DELETE	/fhir/R4/ValueSet/[id]
Create	POST	/fhir/R4/ValueSet
Search	GET	/fhir/R4/ValueSet
History	GET	/fhir/R4/ValueSet/[id]/_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
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 | active | retired | unknown modifier
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 (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
compose	BackboneElement	0..1	Content logical definition of the value set (CLD)
expansion	BackboneElement	0..1	Used when the value set is "expanded"

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
code	string	http://hl7.org/fhir/SearchParameter/ValueSet-code
context	string	http://hl7.org/fhir/SearchParameter/conformance-context
context-quantity	string	http://hl7.org/fhir/SearchParameter/conformance-context-quantity
context-type	string	http://hl7.org/fhir/SearchParameter/conformance-context-type
context-type-quantity	string	http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity
context-type-value	string	http://hl7.org/fhir/SearchParameter/conformance-context-type-value
date	string	http://hl7.org/fhir/SearchParameter/conformance-date
description	string	http://hl7.org/fhir/SearchParameter/conformance-description
expansion	string	http://hl7.org/fhir/SearchParameter/ValueSet-expansion
identifier	string	http://hl7.org/fhir/SearchParameter/conformance-identifier
jurisdiction	string	http://hl7.org/fhir/SearchParameter/conformance-jurisdiction
name	string	http://hl7.org/fhir/SearchParameter/conformance-name
publisher	string	http://hl7.org/fhir/SearchParameter/conformance-publisher
reference	string	http://hl7.org/fhir/SearchParameter/ValueSet-reference
status	string	http://hl7.org/fhir/SearchParameter/conformance-status
title	string	http://hl7.org/fhir/SearchParameter/conformance-title
url	string	http://hl7.org/fhir/SearchParameter/conformance-url
version	string	http://hl7.org/fhir/SearchParameter/conformance-version

Reference

• Official FHIR R4 spec: ValueSet
• Maturity: Normative (FMM 5).