DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 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

Valueset-example-inline.json

Raw JSON (canonical form)

ValueSet Example defining codes using an inline code system

{
  "resourceType": "ValueSet",
  "id": "example-inline",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div>\n      \n      \n      <p>Value set &quot;ACME Codes for Cholesterol&quot;: This is an example value set that includes \n        all the  codes for serum cholesterol defined by ACME inc.</p>\n      \n      \n      <p>Developed by: FHIR project team (example)</p>\n      \n      \n      <p>Published for testing on 13-June 2012</p>\n      \n      \n      <p>This value set includes all the ACME codes for serum cholesterol:</p>\n\t\t\t\n      \n      <table class=\"grid\">\n\t\t\t  \n        \n        <tr>\n\t\t\t\t \n          \n          <td>\n            \n            <b>Code</b>\n          \n          </td>\n\t\t\t\t \n          \n          <td>\n            \n            <b>Display</b>\n          \n          </td>\n\t\t\t\t \n          \n          <td>\n            \n            <b>Definition</b>\n          \n          </td>\n\t\t\t\t\n        \n        </tr>\n\t\t\t  \n        \n        <tr>\n\t\t\t\t \n          \n          <td>chol-mmol</td>\n\t\t\t\t \n          \n          <td>SChol (mmol/L)</td>\n\t\t\t\t \n          \n          <td>Serum Cholesterol, in mmol/L</td>\n\t\t\t\t\n        \n        </tr>\n\t\t\t  \n        \n        <tr>\n\t\t\t\t \n          \n          <td>chol-mass</td>\n\t\t\t\t \n          \n          <td>SChol (mg/L)</td>\n\t\t\t\t \n          \n          <td>Serum Cholesterol, in mg/L</td>\n\t\t\t\t\n        \n        </tr>\n\t\t\t  \n        \n        <tr>\n\t\t\t\t \n          \n          <td>chol</td>\n\t\t\t\t \n          \n          <td>SChol</td>\n\t\t\t\t \n          \n          <td>Serum Cholesterol</td>\n\t\t\t\t\n        \n        </tr>\n\t\t\t\n      \n      </table>\n    \n    \n    </div>"
  },
  "url": "http://hl7.org/fhir/ValueSet/example-inline",
  "_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    "
    ]
  },
  "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-inl"
  },
  "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": "ACME 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",
  "description": "This is an example value set that includes all the ACME codes for serum/plasma cholesterol from v2.36",
  "codeSystem": {
    "fhir_comments": [
      "    \n\t\tThis value set publishes the underlying definition of the ACME code system\n\t\tWe don't keep track of authorship etc  here - we assume that ACME has a\n\t\tsystem for that. We're just representing the public face of the code \n\t\tsystem for external users\n\t   "
    ],
    "system": "http://acme.com/config/fhir/codesystems/cholesterol",
    "_system": {
      "fhir_comments": [
        "   \n\t\t\tnote that since we give a literal URL here, there's an expectation \n\t\t\tthat accessing that URL will give some form of representation of \n\t\t\tthe full code system, or a pointer about how to get more infomration. \n\t\n\t\t\tThis is not an absolute requirement, but it may be enforced by some \n\t\t\tservers - for instance, the HL7 valueset registry will.    "
      ]
    },
    "version": "4.2.3",
    "_version": {
      "fhir_comments": [
        "    version is not mandatory, but is highly recommended. Note that \n\t\t\tyou should change the identify of the code system if existing codes \n\t\t\tare redefined    "
      ]
    },
    "caseSensitive": true,
    "_caseSensitive": {
      "fhir_comments": [
        "    it's often unstated - are codes case sensitive or not. And \n       it can be the cause of operational or clinical safety problems. \n       So FHIR requires that it always be specified.    "
      ]
    },
    "concept": [
      {
        "fhir_comments": [
          "    \n\t\t\tACME's defined definitions. Note that these are not \n\t\t\t*good* definitions - but they are very commonly the kind \n\t\t\tof definitions that are encountered in production\n\t\t   "
        ],
        "code": "chol-mmol",
        "display": "SChol (mmol/L)",
        "definition": "Serum Cholesterol, in mmol/L",
        "designation": [
          {
            "use": {
              "system": "http://acme.com/config/fhir/codesystems/internal",
              "code": "internal-label"
            },
            "value": "From ACME POC Testing"
          }
        ]
      },
      {
        "code": "chol-mass",
        "display": "SChol (mg/L)",
        "definition": "Serum Cholesterol, in mg/L",
        "designation": [
          {
            "use": {
              "system": "http://acme.com/config/fhir/codesystems/internal",
              "code": "internal-label"
            },
            "value": "From Paragon Labs"
          }
        ]
      },
      {
        "code": "chol",
        "display": "SChol",
        "definition": "Serum Cholesterol",
        "designation": [
          {
            "use": {
              "system": "http://acme.com/config/fhir/codesystems/internal",
              "code": "internal-label"
            },
            "value": "Obdurate Labs uses this with both kinds of units..."
          }
        ]
      }
    ]
  }
}

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.