Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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: R4B R4 R3

Example CodeSystem/care-plan-activity-status (JSON)

Patient Care Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemCarePlanActivityStatus

{
  "resourceType" : "CodeSystem",
  "id" : "care-plan-activity-status",
  "meta" : {
    "lastUpdated" : "2022-09-10T04:52:37.223+10: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/care-plan-activity-status</code> defines the following codes:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">not-started<a name=\"care-plan-activity-status-not-started\"> </a></td><td>Not Started</td><td>Care plan activity is planned but no action has yet been taken.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">scheduled<a name=\"care-plan-activity-status-scheduled\"> </a></td><td>Scheduled</td><td>Appointment or other booking has occurred but activity has not yet begun.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">in-progress<a name=\"care-plan-activity-status-in-progress\"> </a></td><td>In Progress</td><td>Care plan activity has been started but is not yet complete.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">on-hold<a name=\"care-plan-activity-status-on-hold\"> </a></td><td>On Hold</td><td>Care plan activity was started but has temporarily ceased with an expectation of resumption at a future time.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">completed<a name=\"care-plan-activity-status-completed\"> </a></td><td>Completed</td><td>Care plan activity has been completed (more or less) as planned.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">cancelled<a name=\"care-plan-activity-status-cancelled\"> </a></td><td>Cancelled</td><td>The planned care plan activity has been withdrawn.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  stopped<a name=\"care-plan-activity-status-stopped\"> </a></td><td>Stopped</td><td>The planned care plan activity has been ended prior to completion after the activity was started.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">unknown<a name=\"care-plan-activity-status-unknown\"> </a></td><td>Unknown</td><td>The current state of the care plan activity is not known.  Note: This concept is not to be used for &quot;other&quot; - one of the listed statuses is presumed to apply, but the authoring/source system does not know which one.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">entered-in-error<a name=\"care-plan-activity-status-entered-in-error\"> </a></td><td>Entered in Error</td><td>Care plan activity was entered in error and voided.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pc"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  }],
  "url" : "http://hl7.org/fhir/care-plan-activity-status",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.147"
  }],
  "version" : "5.0.0-ballot",
  "name" : "CarePlanActivityStatus",
  "title" : "CarePlanActivityStatus",
  "status" : "draft",
  "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" : "Codes that reflect the current state of a care plan activity within its overall life cycle.",
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/care-plan-activity-status",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "concept" : [{
    "code" : "not-started",
    "display" : "Not Started",
    "definition" : "Care plan activity is planned but no action has yet been taken."
  },
  {
    "code" : "scheduled",
    "display" : "Scheduled",
    "definition" : "Appointment or other booking has occurred but activity has not yet begun."
  },
  {
    "code" : "in-progress",
    "display" : "In Progress",
    "definition" : "Care plan activity has been started but is not yet complete."
  },
  {
    "code" : "on-hold",
    "display" : "On Hold",
    "definition" : "Care plan activity was started but has temporarily ceased with an expectation of resumption at a future time."
  },
  {
    "code" : "completed",
    "display" : "Completed",
    "definition" : "Care plan activity has been completed (more or less) as planned."
  },
  {
    "code" : "cancelled",
    "display" : "Cancelled",
    "definition" : "The planned care plan activity has been withdrawn.",
    "concept" : [{
      "code" : "stopped",
      "display" : "Stopped",
      "definition" : "The planned care plan activity has been ended prior to completion after the activity was started."
    }]
  },
  {
    "code" : "unknown",
    "display" : "Unknown",
    "definition" : "The current state of the care plan activity is not known.  Note: This concept is not to be used for \"other\" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which one."
  },
  {
    "code" : "entered-in-error",
    "display" : "Entered in Error",
    "definition" : "Care plan activity was entered in error and voided."
  }]
}

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.