WildFHIR R4 Enterprise Edition Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON

: AEGIS WildFHIR R4 Purge All - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "wildfhir-operation-purge-all",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition wildfhir-operation-purge-all</b></p><a name=\"wildfhir-operation-purge-all\"> </a><a name=\"hcwildfhir-operation-purge-all\"> </a><a name=\"wildfhir-operation-purge-all-en-US\"> </a><p>URL: [base]/$purge-all</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=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>If successful, the operation may contain an OperationOutcome with further information about the purge results (such as warnings or information messages, such as a count of records that were purged / eliminated).</p>\n<p>If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. reference integrity issue, security issue, or insufficient privileges).</p>\n</div></td></tr></table><div><p>Implemented in AEGIS WildFHIR R4 FHIR test server - http://wildfhir4.aegis.net/fhir4-0-1</p>\n</div></div>"
  },
  "url" : "http://wildfhir4.aegis.net/ig/wildfhir/OperationDefinition/wildfhir-operation-purge-all",
  "version" : "1.0.0",
  "name" : "AEGISWildFHIRR4PurgeAll",
  "title" : "AEGIS WildFHIR R4 Purge All",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-03-26",
  "publisher" : "AEGIS.net, Inc.",
  "contact" : [
    {
      "name" : "AEGIS.net, Inc.",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.aegis.net"
        }
      ]
    },
    {
      "name" : "Richard Ettema",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:richard.ettema@aegis.net"
        }
      ]
    }
  ],
  "description" : "This is the WildFHIR R4 Purge All operation. It provides a standardized mechanism to force a hard delete or purge of ALL FHIR resources (and their version history).\n\nThe allowed use of this operation within the AEGIS WildFHIR R4 server is controlled via a configuration setting - true, use is allowed; false, a 400 (Bad Request) with an OperationOutcome is returned.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "purge-all",
  "comment" : "Implemented in AEGIS WildFHIR R4 FHIR test server - http://wildfhir4.aegis.net/fhir4-0-1",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "If successful, the operation may contain an OperationOutcome with further information about the purge results (such as warnings or information messages, such as a count of records that were purged / eliminated).\n\nIf the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. reference integrity issue, security issue, or insufficient privileges).",
      "type" : "OperationOutcome"
    }
  ]
}