Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example ValueSet/inactive (JSON)

Terminology Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

ValueSet including inactive concepts

{
  "resourceType" : "ValueSet",
  "id" : "inactive",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>This value set contains 5 concepts</p>\n      <table class=\"codes\">\n        <tr>\n          <td>\n            <b>Level</b>\n          </td>\n          <td style=\"white-space:nowrap\">\n            <b>Code</b>\n          </td>\n          <td>\n            <b>System</b>\n          </td>\n          <td>\n            <b>Display</b>\n          </td>\n          <td>\n            <b>Definition</b>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <a name=\"http---terminology.hl7.org-CodeSystem-v3-ActMood-CRT\"> </a>1\n          </td>\n          <td style=\"white-space:nowrap\">\u00a0\u00a0\n            <a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActMood.html#v3-ActMood-CRT\">CRT</a>\n          </td>\n          <td>http://terminology.hl7.org/CodeSystem/v3-ActMood</td>\n          <td>criterion</td>\n          <td>\n            <div>\n              <p>\n                <em>\n                  <strong>Deprecation Comment:</strong>\n                </em> This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to &quot;true&quot; and use the desired mood for your criterion.\n              </p>\n\n              <p>\n                <strong>Definition:</strong> A condition that must be true for the source act to be considered.\n              </p>\n\n            </div>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <a name=\"http---terminology.hl7.org-CodeSystem-v3-ActMood-EXPEC\"> </a>1\n          </td>\n          <td style=\"white-space:nowrap\">\u00a0\u00a0\n            <a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActMood.html#v3-ActMood-EXPEC\">EXPEC</a>\n          </td>\n          <td>http://terminology.hl7.org/CodeSystem/v3-ActMood</td>\n          <td>expectation</td>\n          <td>\n            <div>\n              <p>\n                <strong>Definition:</strong> An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event).\n              </p>\n\n              <p>**Examples:**Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning.</p>\n\n              <p>**UsageNotes:**INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with expectation, which is a prediction that something will happen in the future. GOL (goal) reflects a hope rather than a prediction. RSK (risk) reflects a potential negative event that may or may not be expected to happen.</p>\n\n            </div>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <a name=\"http---terminology.hl7.org-CodeSystem-v3-ActMood-GOL\"> </a>2\n          </td>\n          <td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\n            <a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActMood.html#v3-ActMood-GOL\">GOL</a>\n          </td>\n          <td>http://terminology.hl7.org/CodeSystem/v3-ActMood</td>\n          <td>goal</td>\n          <td>\n            <div>\n              <p>\n                <strong>Definition:</strong> An expectation that is considered to be desirable to occur in the future\n              </p>\n\n              <p>**Examples:**Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction.</p>\n\n              <p>\n                <strong>UsageNotes:</strong> INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with goal which doesn't represent an intention to act, merely a hope for an eventual result. A goal is distinct from the intended actions to reach that goal. &quot;I will reduce the dose of drug x to 20mg&quot; is an intent. &quot;I hope to be able to get the patient to the point where I can reduce the dose of drug x to 20mg&quot; is a goal. EXPEC (expectation) reflects a prediction rather than a hope. RSK (risk) reflects a potential negative event rather than a hope.\n              </p>\n\n            </div>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <a name=\"http---terminology.hl7.org-CodeSystem-v3-ActMood-RSK\"> </a>2\n          </td>\n          <td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\n            <a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActMood.html#v3-ActMood-RSK\">RSK</a>\n          </td>\n          <td>http://terminology.hl7.org/CodeSystem/v3-ActMood</td>\n          <td>risk</td>\n          <td>\n            <div>\n              <p>**Definition:**An act that may occur in the future and which is regarded as undesirable</p>\n\n              <p>**Examples:**Increased risk of DVT, at risk for sub-acute bacterial endocarditis.</p>\n\n              <p>**UsageNotes:**Note: An observation in RSK mood expresses the undesirable act, and not the underlying risk factor. A risk factor that is present (e.g. obesity, smoking, etc) should be expressed in event mood. INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen. GOL (goal) reflects a hope to achieve something. EXPEC (expectation) is the prediction of a positive or negative event. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen, and may not be expected to happen.</p>\n\n            </div>\n          </td>\n        </tr>\n        <tr>\n          <td>\n            <a name=\"http---terminology.hl7.org-CodeSystem-v3-ActMood-OPT\"> </a>1\n          </td>\n          <td style=\"white-space:nowrap\">\u00a0\u00a0\n            <a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ActMood.html#v3-ActMood-OPT\">OPT</a>\n          </td>\n          <td>http://terminology.hl7.org/CodeSystem/v3-ActMood</td>\n          <td>option</td>\n          <td>\n            <div>\n              <p>\n                <strong>Definition:</strong> One of a set of acts that specify an option for the property values that the parent act may have. Typically used in definitions or orders to describe alternatives. An option can only be used as a group, that is, all assigned values must be used together. The actual mood of the act is the same as the parent act, and they must be linked by an actrelationship with type = OPTN.\n              </p>\n\n            </div>\n          </td>\n        </tr>\n      </table>\n    </div>"
  },
  "url" : "http://hl7.org/fhir/ValueSet/inactive",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.3146"
  }],
  "version" : "5.0.0",
  "name" : "ExampleInactive",
  "title" : "Example with inactive codes",
  "status" : "draft",
  "experimental" : true,
  "description" : "HL7 v3 ActMood Predicate codes, including inactive codes",
  "compose" : {
    "inactive" : true,
    "include" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
      "filter" : [{
        "property" : "concept",
        "op" : "descendent-of",
        "value" : "_ActMoodPredicate"
      }]
    }]
  },
  "expansion" : {
    "identifier" : "urn:uuid:46c00b3f-003a-4f31-9d4b-ea2de58b2a99",
    "timestamp" : "2017-02-26T10:00:00Z",
    "contains" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
      "inactive" : true,
      "code" : "CRT",
      "display" : "criterion"
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
      "code" : "EXPEC",
      "display" : "expectation",
      "contains" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
        "code" : "GOL",
        "display" : "goal"
      },
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
        "code" : "RSK",
        "display" : "risk"
      }]
    },
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActMood",
      "code" : "OPT",
      "display" : "option"
    }]
  }
}

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.