Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-purge"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Patient-purge</b> 
      </p> 
      <a name="Patient-purge"> </a> 
      <a name="hcPatient-purge"> </a> 
      <a name="Patient-purge-en-US"> </a> 
      <p> URL: [base]/Patient/[id]/$purge</p> 
      <h3> Parameters</h3> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="operationoutcome.html">OperationOutcome</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Status and/or results of the purge request</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Patient-purge"/> 
  <version value="6.0.0-ballot2"/> 
  <name value="Purge"/> 
  <title value="Purge Patient Record"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2024-11-22T13:35:32+00:00"/> 
  <publisher value="HL7 International / Patient Administration"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/pafm"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to request the removal of all current and historical versions
   for all resources in a patient compartment or from a Group of patient compartments.
    The return is an OperationOutcome with results and/or details about execution.

Following are some common `issue-type` values:
- `success` the request has been completed to the server's satisfaction - the patient
   and associated resources are no longer accessible
- `incomplete` the request is partially complete, but additional processing will
   continue (e.g., the server is continuing to clean out resources)

When supported, it is recommended (though not required) to support an [Asynchronous
   Request Pattern](async.html).

Note that the deletion of resources typically involves many policy decisions. 
   Implementers are expected to use this operation in conjunction with their policies
   for such a request - e.g., soft vs. hard delete, audibility/traceability, evaluation
   of referential integrity, etc.."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <affectsState value="false"/> 
  <code value="purge"/> 
  <resource value="Patient"/> 
  <system value="false"/> 
  <type value="false"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="Status and/or results of the purge request"/> 
    <type value="OperationOutcome"/> 
  </parameter> 
</OperationDefinition>