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: R5 R4B R4

Example ValueSet/provenance-history-record-activity (XML)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Value SetProvenance History Record Activity Codes

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

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="provenance-history-record-activity"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/provenance-history-record-activity"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <ul> 
        <li> Include these codes as defined in 
          <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html">
            <code> http://terminology.hl7.org/CodeSystem/v3-DataOperation</code> 
          </a> 
          <table class="none">
            <tr> 
              <td style="white-space:nowrap">
                <b> Code</b> 
              </td> 
              <td> 
                <b> Display</b> 
              </td> 
              <td> 
                <b> Definition</b> 
              </td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-CREATE">CREATE</a> 
              </td> 
              <td> Created</td> 
              <td> Fundamental operation in an Information System (IS) that results only in the act of bringing
                 an object into existence. Note: The preceding definition is taken from the HL7 RBAC specification.
                 There is no restriction on how the operation is invoked, e.g., via a user interface. For
                 an HL7 Act, the state transitions per the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-UPDATE">UPDATE</a> 
              </td> 
              <td> Updated</td> 
              <td> Fundamental operation in an Information System (IS) that results only in the revision
                 or alteration of an object. Note: The preceding definition is taken from the HL7 RBAC
                 specification. There is no restriction on how the operation is invoked, e.g., via a user
                 interface.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-DELETE">DELETE</a> 
              </td> 
              <td> Deleted</td> 
              <td> Fundamental operation in an Information System (IS) that results only in the removal of
                 information about an object from memory or storage. Note: The preceding definition is
                 taken from the HL7 RBAC specification. There is no restriction on how the operation is
                 invoked, e.g., via a user interface.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-ABORT">ABORT</a> 
              </td> 
              <td> Stopped/Ended/Aborted</td> 
              <td> Change the status of an object representing an Act to &quot;aborted&quot;, i.e., terminated
                 prior to the originally intended completion. For an HL7 Act, the state transitions per
                 the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-HOLD">HOLD</a> 
              </td> 
              <td> Held</td> 
              <td> Change the status of an object representing an Act to &quot;held&quot;, i.e., put aside
                 an Act that is still in preparatory stages. No action can occur until the Act is released.
                 For an HL7 Act, the state transitions per the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-RELEASE">RELEASE</a> 
              </td> 
              <td> Released</td> 
              <td> Change the status of an object representing an Act so it is no longer &quot;held&quot;,
                 i.e., allow action to occur. For an HL7 Act, the state transitions per the HL7 Reference
                 Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-CANCEL">CANCEL</a> 
              </td> 
              <td> Cancelled</td> 
              <td> Change the status of an object representing an Act to &quot;cancelled&quot;, i.e., abandoned
                 before activation. For an HL7 Act, the state transitions per the HL7 Reference Information
                 Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-ACTIVATE">ACTIVATE</a> 
              </td> 
              <td> Activated</td> 
              <td> Change the status of an object representing an Act to &quot;active&quot;, i.e., so it
                 can be performed or is being performed, for the first time. (Contrast with REACTIVATE.)
                 For an HL7 Act, the state transitions per the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-SUSPEND">SUSPEND</a> 
              </td> 
              <td> Suspended</td> 
              <td> Change the status of an object representing an Act to **suspended**, i.e., so it is temporarily
                 not in service.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-RESUME">RESUME</a> 
              </td> 
              <td> resume</td> 
              <td> Change the status of a suspended object representing an Act to &quot;active&quot;, i.e.,
                 so it can be performed or is being performed. For an HL7 Act, the state transitions per
                 the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-COMPLETE">COMPLETE</a> 
              </td> 
              <td> Completed</td> 
              <td> Change the status of an object representing an Act to &quot;completed&quot;, i.e., terminated
                 normally after all of its constituents have been performed. For an HL7 Act, the state
                 transitions per the HL7 Reference Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-NULLIFY">NULLIFY</a> 
              </td> 
              <td> Mark Entered-in-error</td> 
              <td> Change the status of an object representing an Act to &quot;nullified&quot;, i.e., treat
                 as though it never existed. For an HL7 Act, the state transitions per the HL7 Reference
                 Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-OBSOLETE">OBSOLETE</a> 
              </td> 
              <td> Replaced</td> 
              <td> Change the status of an object representing an Act to &quot;obsolete&quot; when it has
                 been replaced by a new instance. For an HL7 Act, the state transitions per the HL7 Reference
                 Information Model.</td> 
            </tr> 
            <tr> 
              <td> 
                <a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-DataOperation.html#v3-DataOperation-REACTIVATE">REACTIVATE</a> 
              </td> 
              <td> Reactivated</td> 
              <td> Change the status of a formerly active object representing an Act to &quot;active&quot;,
                 i.e., so it can again be performed or is being performed. (Contrast with ACTIVATE.) For
                 an HL7 Act, the state transitions per the HL7 Reference Information Model.</td> 
            </tr> 
          </table> 
        </li> 
      </ul> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="sec"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/provenance-history-record-activity"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.3.926"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="ProvenanceHistoryRecordActivityCodes"/> 
  <title value="Provenance History Record Activity Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Codes for Provenance activities that are relevant when capturing event history for resources."/> 
  <compose> 
    <include> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-DataOperation"/> 
      <concept> 
        <code value="CREATE"/> 
        <display value="Created"/> 
      </concept> 
      <concept> 
        <code value="UPDATE"/> 
        <display value="Updated"/> 
      </concept> 
      <concept> 
        <code value="DELETE"/> 
        <display value="Deleted"/> 
      </concept> 
      <concept> 
        <code value="ABORT"/> 
        <display value="Stopped/Ended/Aborted"/> 
      </concept> 
      <concept> 
        <code value="HOLD"/> 
        <display value="Held"/> 
      </concept> 
      <concept> 
        <code value="RELEASE"/> 
        <display value="Released"/> 
      </concept> 
      <concept> 
        <code value="CANCEL"/> 
        <display value="Cancelled"/> 
      </concept> 
      <concept> 
        <code value="ACTIVATE"/> 
        <display value="Activated"/> 
      </concept> 
      <concept> 
        <code value="SUSPEND"/> 
        <display value="Suspended"/> 
      </concept> 
      <concept> 
        <code value="RESUME"/> 
      </concept> 
      <concept> 
        <code value="COMPLETE"/> 
        <display value="Completed"/> 
      </concept> 
      <concept> 
        <code value="NULLIFY"/> 
        <display value="Mark Entered-in-error"/> 
      </concept> 
      <concept> 
        <code value="OBSOLETE"/> 
        <display value="Replaced"/> 
      </concept> 
      <concept> 
        <code value="REACTIVATE"/> 
        <display value="Reactivated"/> 
      </concept> 
    </include> 
  </compose> 
</ValueSet>

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.