DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Valueset-example-expansion.json

Raw JSON (canonical form)

ValueSet Example using a prepared expansion

{
  "resourceType": "ValueSet",
  "id": "example-expansion",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div>\n      <table class=\"grid\">\n        <tr>\n          <td>http://loinc.org</td>\n          <td>14647-2</td>\n          <td>Cholesterol [Moles/volume] in Serum or Plasma</td>\n        </tr>\n        <tr>\n          <td colspan=\"3\">\n            <b>Additional Cholesterol codes</b>\n          </td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>2093-3</td>\n          <td>Cholesterol [Mass/volume] in Serum or Plasma</td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>48620-9</td>\n          <td>Cholesterol [Mass/volume] in Serum or Plasma ultracentrifugate</td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>9342-7</td>\n          <td>Cholesterol [Percentile]</td>\n        </tr>\n        <tr>\n          <td colspan=\"3\">\n            <b>Cholesterol Ratios</b>\n          </td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>2096-6</td>\n          <td>Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma</td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>35200-5</td>\n          <td>Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma</td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>48089-7</td>\n          <td>Cholesterol/Apolipoprotein B [Molar ratio] in Serum or Plasma</td>\n        </tr>\n        <tr>\n          <td>http://loinc.org</td>\n          <td>55838-7</td>\n          <td>Cholesterol/Phospholipid [Molar ratio] in Serum or Plasma</td>\n        </tr>\n      </table>\n    </div>"
  },
  "url": "http://hl7.org/fhir/ValueSet/example-expansion",
  "version": "20150622",
  "name": "LOINC Codes for Cholesterol in Serum/Plasma",
  "status": "draft",
  "experimental": true,
  "publisher": "FHIR Project team",
  "_publisher": {
    "fhir_comments": [
      "    Expansions that are not intended for persistence often do not have \n   all the metadata. But this one, intended for persistence, does    "
    ]
  },
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2015-06-22",
  "description": "This is an example value set that includes all the LOINC codes for serum/plasma cholesterol from v2.36.",
  "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.",
  "compose": {
    "fhir_comments": [
      "    it's optional whether to include the content logical definition, but \n\t  when an expansion is being persisted, it's better to do so (avoids\n\t\tsubsequent mystification as to what the intent was)\n\t   "
    ],
    "include": [
      {
        "system": "http://loinc.org",
        "filter": [
          {
            "property": "parent",
            "op": "=",
            "value": "LP43571-6"
          }
        ]
      }
    ]
  },
  "expansion": {
    "fhir_comments": [
      "   \n  \tok, and now the expansion \n      "
    ],
    "extension": [
      {
        "fhir_comments": [
          "    a reference to the original content - if there is one. Note that \n\t\twhen you store an expansion, there often won't be one    "
        ],
        "url": "http://hl7.org/fhir/StructureDefinition/valueset-expansionSource",
        "valueUri": "http://hl7.org/fhir/ValueSet/example-extensional"
      }
    ],
    "identifier": "urn:uuid:42316ff8-2714-4680-9980-f37a6d1a71bc",
    "_identifier": {
      "fhir_comments": [
        "    always assigned to any expansion, this is cacheable id    "
      ]
    },
    "timestamp": "2015-06-22T13:56:07Z",
    "_timestamp": {
      "fhir_comments": [
        "    this instance of expansion    "
      ]
    },
    "total": 8,
    "_total": {
      "fhir_comments": [
        "    it's useful to routinely fill out the total    "
      ]
    },
    "offset": 0,
    "_offset": {
      "fhir_comments": [
        "    providing an offset - implies that this expansion was requested using paging -    "
      ]
    },
    "parameter": [
      {
        "fhir_comments": [
          "    \n\t\t  now, parameters that describe how the expansion was generated.\n\t\t\tThese may help with managing caching, or limit its use \n\t\t\t(e.g. this expansion was generated for a text filter)    "
        ],
        "name": "version",
        "_name": {
          "fhir_comments": [
            "    for now, parameter names and values are server specific.\n\t\t\t   it is likely these will be standardised in a future version.\n\t\t\t\t \n\t\t\t\t This example: underlying LOINC version    "
          ]
        },
        "valueString": "2.50"
      }
    ],
    "contains": [
      {
        "fhir_comments": [
          "    and the actual expansion    ",
          "    \n\t\t  this expansion is made as a hierarchy - a preferred code, followed by two \n\t\t\tsets of codes categorised by a label. This is to help a human user \n\t\t\tnavigate the list (e.g. in a picklist)\n\t\t\t\n\t\t\tNote that the hierarchy may not have anything to do with the\n\t\t\tdefinitions of the codes (e.g. could be divided into common and less common)\n\t\t\t\n\t\t\tBuilding a hierarchy like this is not explicitly specified in a standard value set,\n\t\t\tbut may be controlled by extensions, the expansion profile, or just performed\n\t\t\tby the expansion service.\n\t\t   "
        ],
        "system": "http://loinc.org",
        "version": "2.50",
        "_version": {
          "fhir_comments": [
            "    \n\t\t\t\tthe version can be specified for either the expansion, or\n\t\t\t\teach individual codes. Technically, these aren't quite the same \n\t\t\t\tthing, but it would be pretty weird for them to differ using LOINC\n\t\t\t   "
          ]
        },
        "code": "14647-2",
        "display": "Cholesterol [Moles/volume] in Serum or Plasma"
      },
      {
        "abstract": true,
        "display": "Cholesterol codes",
        "contains": [
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "2093-3",
            "display": "Cholesterol [Mass/volume] in Serum or Plasma"
          },
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "48620-9",
            "display": "Cholesterol [Mass/volume] in Serum or Plasma ultracentrifugate"
          },
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "9342-7",
            "display": "Cholesterol [Percentile]"
          }
        ]
      },
      {
        "abstract": true,
        "display": "Cholesterol Ratios",
        "contains": [
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "2096-6",
            "display": "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma"
          },
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "35200-5",
            "display": "Cholesterol/Triglyceride [Mass Ratio] in Serum or Plasma"
          },
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "48089-7",
            "display": "Cholesterol/Apolipoprotein B [Molar ratio] in Serum or Plasma"
          },
          {
            "system": "http://loinc.org",
            "version": "2.50",
            "code": "55838-7",
            "display": "Cholesterol/Phospholipid [Molar ratio] in Serum or Plasma"
          }
        ]
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.