API Reference

Create a new ValueSet

ValueSet on the FHIR specification website.

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.

The body should be a valid FHIR object for ValueSet.

Here is an example:

{
  "resourceType": "ValueSet",
  "id": "abstract-types",
  "meta": {
    "lastUpdated": "2019-11-01T09:29:23.356+11:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <h2>AbstractType</h2>\n            <div>\n              <p>A list of the base types defined by this version of the FHIR specification - types that are defined, but for which only specializations actually are created.</p>\n\n            </div>\n            <p>This value set includes codes from the following code systems:</p>\n            <ul>\n              <li>Include all codes defined in \n                <a href=\"codesystem-abstract-types.html\">\n                  <code>http://hl7.org/fhir/abstract-types</code>\n                </a>\n              </li>\n            </ul>\n          </div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-special-status",
      "valueString": "This Value Set is normative - it is generated based on the information defined in this specification. The definition will remain fixed  across versions, but the actual contents will change from version to version"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "normative"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
      "valueCode": "4.0.0"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    }
  ],
  "url": "http://hl7.org/fhir/ValueSet/abstract-types",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.3.23"
    }
  ],
  "version": "4.0.1",
  "name": "AbstractType",
  "title": "AbstractType",
  "status": "active",
  "experimental": false,
  "date": "2019-11-01T09:29:23+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "[email protected]"
        }
      ]
    }
  ],
  "description": "A list of the base types defined by this version of the FHIR specification - types that are defined, but for which only specializations actually are created.",
  "immutable": true,
  "compose": {
    "include": [
      {
        "system": "http://hl7.org/fhir/abstract-types"
      }
    ]
  }
}

You can reference the FHIR documentation to determine the format for ValueSet.

Language
Credentials
Click Try It! to start a request and see the response here!