Release 5 Ballot

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

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

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

Definition for Code SystemCarePlanActivityStatus

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="care-plan-activity-status"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <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> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pc"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  <url value="http://hl7.org/fhir/care-plan-activity-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.147"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="CarePlanActivityStatus"/> 
  <title value="CarePlanActivityStatus"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Codes that reflect the current state of a care plan activity within its overall life cycle."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/care-plan-activity-status"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="not-started"/> 
    <display value="Not Started"/> 
    <definition value="Care plan activity is planned but no action has yet been taken."/> 
  </concept> 
  <concept> 
    <code value="scheduled"/> 
    <display value="Scheduled"/> 
    <definition value="Appointment or other booking has occurred but activity has not yet begun."/> 
  </concept> 
  <concept> 
    <code value="in-progress"/> 
    <display value="In Progress"/> 
    <definition value="Care plan activity has been started but is not yet complete."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="Care plan activity was started but has temporarily ceased with an expectation of resumption
     at a future time."/> 
  </concept> 
  <concept> 
    <code value="completed"/> 
    <display value="Completed"/> 
    <definition value="Care plan activity has been completed (more or less) as planned."/> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The planned care plan activity has been withdrawn."/> 
    <concept> 
      <code value="stopped"/> 
      <display value="Stopped"/> 
      <definition value="The planned care plan activity has been ended prior to completion after the activity was
       started."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="unknown"/> 
    <display value="Unknown"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="Care plan activity was entered in error and voided."/> 
  </concept> 
</CodeSystem> 

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.