ValueSet - FHIR Resource (dstu2)
This ValueSet Resource uses the FHIR API standard for access and structure.
Validate an ValueSet FHIR Resource (dstu2)
ValueSet Attributes
AttributeField is listTypeDescription
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (ValueSet) status FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (ValueSet) publisher FHIR attribute
Description: C? When value set includes codes from elsewhere
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"compose": Learn more about the (ValueSet) compose FHIR attribute
Description: Why needed
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requirements": Learn more about the (ValueSet) requirements FHIR attribute
Description: Informal name for this value set
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (ValueSet) name FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (ValueSet) copyright FHIR attribute
Description: Globally unique logical identifier for value set
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (ValueSet) url FHIR attribute
Description: Human language description of the value set
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (ValueSet) description FHIR attribute
Description: Fixed date for all referenced code systems and value sets
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lockedDate": Learn more about the (ValueSet) lockedDate FHIR attribute
Description: C? An inline code system, which is part of this value set
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"codeSystem": Learn more about the (ValueSet) codeSystem FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (ValueSet) contact FHIR attribute
Description: Content intends to support these contexts
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (ValueSet) useContext FHIR attribute
Description: C? Used when the value set is "expanded"
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expansion": Learn more about the (ValueSet) expansion FHIR attribute
Description: Logical identifier for this version of the value set
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (ValueSet) version FHIR attribute
Description: Date for given status
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (ValueSet) date FHIR attribute
Description: Additional identifier for the value set (e.g. HL7 v2 / CDA)
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (ValueSet) identifier FHIR attribute
Description: Indicates whether or not any change to the content logical definition may occur
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"immutable": Learn more about the (ValueSet) immutable FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (ValueSet) experimental FHIR attribute
Description: Whether this is intended to be used with an extensible binding
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"extensible": Learn more about the (ValueSet) extensible FHIR attribute
ValueSet Structure
{
"resourceType" : "ValueSet",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Globally unique logical identifier for value set
"identifier" : { Identifier }, // Additional identifier for the value set (e.g. HL7 v2 / CDA)
"version" : "<string>", // Logical identifier for this version of the value set
"name" : "<string>", // Informal name for this value set
"status" : "<code>", // R! draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Date for given status
"lockedDate" : "<date>", // Fixed date for all referenced code systems and value sets
"description" : "<string>", // Human language description of the value set
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"immutable" : <boolean>, // Indicates whether or not any change to the content logical definition may occur
"requirements" : "<string>", // Why needed
"copyright" : "<string>", // Use and/or publishing restrictions
"extensible" : <boolean>, // Whether this is intended to be used with an extensible binding
"codeSystem" : { // C? An inline code system, which is part of this value set
"system" : "<uri>", // R! URI to identify the code system (e.g. in Coding.system)
"version" : "<string>", // Version (for use in Coding.version)
"caseSensitive" : <boolean>, // If code comparison is case sensitive
"concept" : [{ // R! Concepts in the code system
"code" : "<code>", // R! Code that identifies concept
"abstract" : <boolean>, // If this code is not for use as a real concept
"display" : "<string>", // Text to display to the user
"definition" : "<string>", // Formal definition
"designation" : [{ // Additional representations for the concept
"language" : "<code>", // Human language of the designation
"use" : { Coding }, // Details how this designation would be used
"value" : "<string>" // R! The text value for this designation
}],
"concept" : [{ Content as for ValueSet.codeSystem.concept }] // Child Concepts (is-a/contains/categorizes)
}]
},
"compose" : { // C? When value set includes codes from elsewhere
"import" : ["<uri>"], // C? Import the contents of another value set
"include" : [{ // C? Include one or more codes from a code system
"system" : "<uri>", // R! The system the codes come from
"version" : "<string>", // Specific version of the code system referred to
"concept" : [{ // C? A concept defined in the system
"code" : "<code>", // R! Code or expression from system
"display" : "<string>", // Test to display for this code for this value set
"designation" : [{ Content as for ValueSet.codeSystem.concept.designation }] // Additional representations for this valueset
}],
"filter" : [{ // C? Select codes/concepts by their properties (including relationships)
"property" : "<code>", // R! A property defined by the code system
"op" : "<code>", // R! = | is-a | is-not-a | regex | in | not-in
"value" : "<code>" // R! Code from the system, or regex criteria
}]
}],
"exclude" : [{ Content as for ValueSet.compose.include }] // C? Explicitly exclude codes
},
"expansion" : { // C? Used when the value set is "expanded"
"identifier" : "<uri>", // R! Uniquely identifies this expansion
"timestamp" : "<dateTime>", // R! Time ValueSet expansion happened
"total" : <integer>, // Total number of codes in the expansion
"offset" : <integer>, // Offset at which this resource starts
"parameter" : [{ // Parameter that controlled the expansion process
"name" : "<string>", // R! Name as assigned by the server
// value[x]: Value of the named parameter. One of these 6:
"valueString" : "<string>"
"valueBoolean" : <boolean>
"valueInteger" : <integer>
"valueDecimal" : <decimal>
"valueUri" : "<uri>"
"valueCode" : "<code>"
}],
"contains" : [{ // Codes in the value set
"system" : "<uri>", // System value for the code
"abstract" : <boolean>, // If user cannot select this entry
"version" : "<string>", // Version in which this code/display is defined
"code" : "<code>", // C? Code - if blank, this is not a selectable code
"display" : "<string>", // C? User display for the concept
"contains" : [{ Content as for ValueSet.expansion.contains }] // Codes contained under this entry
}]
}
}
ValueSet Search Parameters
The following search parameters can be used to query ValueSet resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/ValueSet?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | codeSystem.concept.code |
context | text | useContext |
date | date | date |
description | text | description |
expansion | uri | expansion.identifier |
identifier | text | identifier |
name | text | name |
publisher | text | publisher |
reference | uri | compose.include.system |
status | text | status |
system | uri | codeSystem.system |
url | uri | url |
version | text | version |
