FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/Patient-purge (Turtle)

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

Raw Turtle (+ also see Turtle/RDF Format Specification)

Operation Definition

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/Patient-purge> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "Patient-purge"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<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>\n</div></td></tr></table></div>"^^rdf:XMLLiteral
  ] ; # 
  fhir:extension ( [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:integer ;
       fhir:v 5
     ]
  ] [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:code ;
       fhir:v "trial-use"
     ]
  ] [
     fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
     fhir:value [
       a fhir:code ;
       fhir:v "pa"
     ]
  ] ) ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/Patient-purge"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "6.0.0-ballot2"] ; # 
  fhir:name [ fhir:v "Purge"] ; # 
  fhir:title [ fhir:v "Purge Patient Record"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:experimental [ fhir:v false] ; # 
  fhir:date [ fhir:v "2025-03-11T09:25:29+00:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "HL7 International / Patient Administration"] ; # 
  fhir:contact ( [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] [
       fhir:system [ fhir:v "email" ] ;
       fhir:value [ fhir:v "fhir@lists.hl7.org" ]
     ] )
  ] [
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pafm" ]
     ] )
  ] ) ; # 
  fhir:description [ fhir:v "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.\r\rFollowing are some common `issue-type` values:\r- `success` the request has been completed to the server's satisfaction - the patient and associated resources are no longer accessible\r- `incomplete` the request is partially complete, but additional processing will continue (e.g., the server is continuing to clean out resources)\r\rWhen supported, it is recommended (though not required) to support an [Asynchronous Request Pattern](async.html).\r\rNote 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.."] ; # 
  fhir:jurisdiction ( [
     fhir:coding ( [
       fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "001" ] ;
       fhir:display [ fhir:v "World" ]
     ] )
  ] ) ; # 
  fhir:affectsState [ fhir:v false] ; # 
  fhir:code [ fhir:v "purge"] ; # 
  fhir:resource ( [ fhir:v "Patient"] ) ; # 
  fhir:system [ fhir:v false] ; # 
  fhir:type [ fhir:v false] ; # 
  fhir:instance [ fhir:v true] ; # 
  fhir:parameter ( [
     fhir:name [ fhir:v "return" ] ;
     fhir:use [ fhir:v "out" ] ;
     fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;
     fhir:max [ fhir:v "1" ] ;
     fhir:documentation [ fhir:v "Status and/or results of the purge request" ] ;
     fhir:type [ fhir:v "OperationOutcome" ]
  ] ) . # 

# -------------------------------------------------------------------------------------


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.