R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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

Example CodeSystem/action-required-behavior (JSON)

Clinical Decision Support Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemActionRequiredBehavior

{
  "resourceType" : "CodeSystem",
  "id" : "action-required-behavior",
  "meta" : {
    "lastUpdated" : "2023-03-01T23:03:57.298+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/action-required-behavior</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">must<a name=\"action-required-behavior-must\"> </a></td><td>Must</td><td>An action with this behavior must be included in the actions processed by the end user; the end user SHALL NOT choose not to include this action.</td></tr><tr><td style=\"white-space:nowrap\">could<a name=\"action-required-behavior-could\"> </a></td><td>Could</td><td>An action with this behavior may be included in the set of actions processed by the end user.</td></tr><tr><td style=\"white-space:nowrap\">must-unless-documented<a name=\"action-required-behavior-must-unless-documented\"> </a></td><td>Must Unless Documented</td><td>An action with this behavior must be included in the set of actions processed by the end user, unless the end user provides documentation as to why the action was not included.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cds"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  }],
  "url" : "http://hl7.org/fhir/action-required-behavior",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.804"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.787"
  }],
  "version" : "5.0.0-draft-final",
  "name" : "ActionRequiredBehavior",
  "title" : "Action Required Behavior",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Defines expectations around whether an action or action group is required.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/action-required-behavior",
  "content" : "complete",
  "concept" : [{
    "code" : "must",
    "display" : "Must",
    "definition" : "An action with this behavior must be included in the actions processed by the end user; the end user SHALL NOT choose not to include this action."
  },
  {
    "code" : "could",
    "display" : "Could",
    "definition" : "An action with this behavior may be included in the set of actions processed by the end user."
  },
  {
    "code" : "must-unless-documented",
    "display" : "Must Unless Documented",
    "definition" : "An action with this behavior must be included in the set of actions processed by the end user, unless the end user provides documentation as to why the action was not included."
  }]
}

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.