ValueSet - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
composefalseData Type C? Definition of the content of the value set (CLD)
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the value set
expansionfalseData Type C? Used when the value set is "expanded"
experimentalfalseboolean For testing purposes, not real usage
extensiblefalseboolean Whether this is intended to be used with an extensible binding
identifiertrueIdentifier Additional identifier for the value set
immutablefalseboolean Indicates whether or not any change to the content logical definition may occur
jurisdictiontrueCodeableConcept Intended jurisdiction for value set (if applicable)
namefalsestring Name for this value set (computer friendly)
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this value set is defined
statusfalsecode draft | active | retired | unknown
titlefalsestring Name for this value set (human friendly)
urlfalseuri Logical URI to reference this value set (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the value set

ValueSet Example

{
  "status": "draft",
  "publisher": "HL7 International",
  "compose": {
    "include": [
      {
        "concept": [
          {
            "code": "14647-2",
            "display": "Cholesterol [Moles/Volume]"
          },
          {
            "code": "2093-3",
            "display": "Cholesterol [Mass/Volume]"
          },
          {
            "code": "35200-5",
            "display": "Cholesterol [Mass Or Moles/Volume]"
          },
          {
            "code": "9342-7",
            "display": "Cholesterol [Percentile]"
          }
        ],
        "version": "2.36",
        "system": "http://loinc.org"
      }
    ],
    "inactive": true,
    "lockedDate": "2012-06-13"
  },
  "version": "20150622",
  "copyright": "This content from LOINC ® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use.",
  "resourceType": "ValueSet",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>Value set &quot;LOINC Codes for Cholesterol&quot;: This is an example value set that includes \n        all the  codes for serum cholesterol from LOINC v2.36.</p>\n\t\t\t<p>Developed by: FHIR project team (example)</p>\n\t\t\t<p>Published for testing on 13-June 2012</p>\n\t\t\t<p>This value set includes the following LOINC codes:</p>\n\t\t\t<ul>\n\t\t\t\t<li>14647-2: Cholesterol [Moles/Volume]</li>\n\t\t\t\t<li>2093-3: Cholesterol [Mass/Volume]</li>\n\t\t\t\t<li>35200-5: Cholesterol [Mass Or Moles/Volume] </li>\n\t\t\t\t<li>9342-7: Cholesterol [Percentile]</li>\n\t\t\t</ul>\n\t\t\t<p>This content from LOINC® is copyright © 1995 Regenstrief Institute, Inc. and the LOINC Committee, and available at no cost under the license at http://loinc.org/terms-of-use.</p>\n\t\t</div>"
  },
  "description": "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36.",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ],
      "name": "FHIR project team"
    }
  ],
  "url": "http://hl7.org/fhir/ValueSet/example-extensional",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
    ]
  },
  "date": "2015-06-22",
  "identifier": [
    {
      "system": "http://acme.com/identifiers/valuesets",
      "value": "loinc-cholesterol-int"
    }
  ],
  "id": "example-extensional",
  "experimental": true,
  "name": "LOINC Codes for Cholesterol in Serum/Plasma"
}

ValueSet Structure


  
{
  "resourceType" : "ValueSet",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this value set (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the value set
  "version" : "<string>", // Business version of the value set
  "name" : "<string>", // Name for this value set (computer friendly)
  "title" : "<string>", // Name for this value set (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the value set
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for value set (if applicable)
  "immutable" : <boolean>, // Indicates whether or not any change to the content logical definition may occur
  "purpose" : "<markdown>", // Why this value set is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "extensible" : <boolean>, // Whether this is intended to be used with an extensible binding
  "compose" : { // C? Definition of the content of the value set (CLD)
    "lockedDate" : "<date>", // Fixed date for version-less references (transitive)
    "inactive" : <boolean>, // Whether inactive codes are in the value set
    "include" : [{ // R!  Include one or more codes from a code system or other value set(s)
      "system" : "<uri>", // C? 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>", // Text to display for this code for this value set in this valueset
        "designation" : [{ // Additional representations for this 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
        }]
      }],
      "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 | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
        "value" : "<code>" // R!  Code from the system, or regex criteria, or boolean value for exists
      }],
      "valueSet" : ["<uri>"] // C? Select only contents included in this value set
    }],
    "exclude" : [{ Content as for ValueSet.compose.include }] // C? Explicitly exclude codes from a code system or other value sets
  },
  "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
      "inactive" : <boolean>, // If concept is inactive in the code system
      "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
      "designation" : [{ Content as for ValueSet.compose.include.concept.designation }], // Additional representations for this item
      "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/stu3/ValueSet?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedatedate
descriptiontextdescription
expansionuriexpansion.identifier
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
referenceuricompose.include.system
statustextstatus
titletexttitle
urluriurl
versiontextversion