ValueSet - FHIR Resource (dstu2)


This ValueSet Resource uses the FHIR API standard for access and structure.

Validate an ValueSet FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
codeSystemfalseData Type# C? An inline code system, which is part of this value set
composefalseData Type# C? When value set includes codes from elsewhere
contacttrueData Type# Contact details of the publisher
copyrightfalsestring# Use and/or publishing restrictions
datefalsedateTime# Date for given status
descriptionfalsestring# Human language description of the value set
expansionfalseData Type# C? Used when the value set is "expanded"
experimentalfalseboolean# If for testing purposes, not real usage
extensiblefalseboolean# Whether this is intended to be used with an extensible binding
identifierfalseIdentifier# Additional identifier for the value set (e.g. HL7 v2 / CDA)
immutablefalseboolean# Indicates whether or not any change to the content logical definition may occur
lockedDatefalsedate# Fixed date for all referenced code systems and value sets
namefalsestring# Informal name for this value set
publisherfalsestring# Name of the publisher (organization or individual)
requirementsfalsestring# Why needed
statusfalsecode# draft | active | retired
urlfalseuri# Globally unique logical identifier for value set
useContexttrueCodeableConcept# Content intends to support these contexts
versionfalsestring# Logical identifier for this version of the value set

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 the like so:

https://api.1up.health/fhir/dstu2/ValueSet?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcodeSystem.concept.code
contexttextuseContext
datedatedate
descriptiontextdescription
expansionuriexpansion.identifier
identifiertextidentifier
nametextname
publishertextpublisher
referenceuricompose.include.system
statustextstatus
systemuricodeSystem.system
urluriurl
versiontextversion