STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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.json

Raw JSON (canonical form)

ValueSet Example using enumeration of codes (extensional)

{
  "resourceType": "ValueSet",
  "id": "example-extensional",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"
    ],
    "_profile": [
      {
        "fhir_comments": [
          "    shareable value sets are fully described, and can be put in the HL7 registry    "
        ]
      }
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div>\n      <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      <p>Developed by: FHIR project team (example)</p>\n      <p>Published for testing on 13-June 2012</p>\n      <p>This value set includes the following LOINC codes:</p>\n      <ul>\n        <li>14647-2: Cholesterol [Moles/Volume]</li>\n        <li>2093-3: Cholesterol [Mass/Volume]</li>\n        <li>35200-5: Cholesterol [Mass Or Moles/Volume] </li>\n        <li>9342-7: Cholesterol [Percentile]</li>\n      </ul>\n      <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    </div>"
  },
  "url": "http://hl7.org/fhir/ValueSet/example-extensional",
  "_url": {
    "fhir_comments": [
      "    \n\t  for this example, we use a real URI, since this example does have a canonical address\n\t\tat which it's posted. Alternatively, We could have used an OID, or a UUID.\n \n    Mote that this isn't the identifier for the LOINC codes themeselves - they belong to LOINC, and \n\t\tit has it's own identifier. This is the identifier for this set of codes, and that doesn't \n\t\tchange the codes.\n     "
    ]
  },
  "identifier": {
    "fhir_comments": [
      "    an imaginary identifier. This is a non FHIR identifier - might be used in a \n\t  v2 context (though you always need to translate namespaces for v2)    "
    ],
    "system": "http://acme.com/identifiers/valuesets",
    "value": "loinc-cholesterol-int"
  },
  "version": "20150622",
  "_version": {
    "fhir_comments": [
      "    for version, we are going to simply use the day of publication. This is also \n    arbitrary - whatever is here is what people use to refer to the version. \n    Could also be a UUID too    "
    ]
  },
  "name": "LOINC Codes for Cholesterol in Serum/Plasma",
  "_name": {
    "fhir_comments": [
      "    set of loinc codes for cholesterol for LONC 2.36    "
    ]
  },
  "status": "draft",
  "experimental": true,
  "publisher": "HL7 International",
  "contact": [
    {
      "name": "FHIR project team",
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2015-06-22",
  "lockedDate": "2012-06-13",
  "_lockedDate": {
    "fhir_comments": [
      "    \n\t  if we didn't specify the version of LOINC on the include, then\n\t  we could specify it implicitly by specifying the locked date for the value set\n\t\t\n\t\tSo we show this example here, but it's not actually necessary since we also \n    have LOINC version. Note: if you do what this example does, and specify both,\n\t\tyou better get it right, and specify the current version of LOINC at the time\n     "
    ]
  },
  "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": {
    "include": [
      {
        "fhir_comments": [
          "    you could have multiple includes, if you wanted to include codes from more than\n     one code system, or include codes with different modes. we don't, in this case    "
        ],
        "system": "http://loinc.org",
        "version": "2.36",
        "concept": [
          {
            "fhir_comments": [
              "    for LOINC, we simply include the listed codes - no subsumption in LOINC    ",
              "    these were selected by hand    "
            ],
            "code": "14647-2",
            "display": "Cholesterol [Moles/Volume]",
            "_display": {
              "fhir_comments": [
                "    \n\t\t\t\t  In this value set, we provide our own displays. \n\t\t\t\t\t\n\t\t\t\t\tYou have to be very careful doing this; it's all too \n\t\t\t\t\teasy to specify a different or lesser meaning, and then\n\t\t\t\t\tpeople use codes wrongly ()with obvious consequences for clinical safety)\n\t\t\t\t\n\t\t\t\t  You're allowed to do this in a value set for 2 reasons:\n\t\t\t\t\t  - people do it anyway\n\t\t\t\t\t\t- it does make sense to remove common text that's fixed in the context\n\t\t\t\t\t\t\n\t\t\t    In this case, that's what we're doing here - removing\n\t\t\t\t\t'serum/plasma' from the names, since that's specified in the\n\t\t\t\t\tvalue set name    "
              ]
            }
          },
          {
            "code": "2093-3",
            "display": "Cholesterol [Mass/Volume]"
          },
          {
            "code": "35200-5",
            "display": "Cholesterol [Mass Or Moles/Volume]"
          },
          {
            "fhir_comments": [
              "    this is a different kind of code; whether it should be \n\t\t\t  in a value set like this is a matter of clinical judgement.\n\t\t\t\tit's here in this example value set to raise the question\n\t\t\t\tfor implementers    "
            ],
            "code": "9342-7",
            "display": "Cholesterol [Percentile]"
          }
        ]
      }
    ]
  }
}

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.