WildFHIR R4 Enterprise Edition Implementation Guide
1.0.0 - current
WildFHIR R4 Enterprise Edition Implementation Guide
1.0.0 - current
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
| Active as of 2025-03-26 |
{
"resourceType" : "OperationDefinition",
"id" : "wildfhir-operation-patient-purge",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition wildfhir-operation-patient-purge</b></p><a name=\"wildfhir-operation-patient-purge\"> </a><a name=\"hcwildfhir-operation-patient-purge\"> </a><a name=\"wildfhir-operation-patient-purge-en-US\"> </a><p>URL: [base]/Patient/$purge</p><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>IN</td><td>start</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..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-patient-purge",
"version" : "1.0.0",
"name" : "AEGISWildFHIRR4PatientPurge",
"title" : "AEGIS WildFHIR R4 Patient Purge",
"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 Patient Purge operation. It provides a standardized mechanism to force a hard delete or purge of all referenced FHIR resources to a specific Patient. The operation behaves similar to the Patient $everything operation where the Patient Compartment definition is used to discover all related Patient data.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"affectsState" : false,
"code" : "purge",
"comment" : "Implemented in AEGIS WildFHIR R4 FHIR test server - http://wildfhir4.aegis.net/fhir4-0-1",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : true,
"parameter" : [
{
"name" : "start",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.",
"type" : "date"
},
{
"name" : "end",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.",
"type" : "date"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"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"
}
]
}