delete
Remove a specific FHIR resource instance by its ID or conditionally delete resources matching search criteria. Supports custom FHIR operations like $expunge for targeted deletion operations.
Instructions
Execute a FHIR delete interaction on a specific resource instance. Use this tool when you need to remove a single resource identified by its logical ID or optionally filtered by search parameters. The optional id parameter must match an existing resource instance when present. If you include searchParam, the server will perform a conditional delete, deleting the resource only if it matches the given criteria. If you supply operation, it will execute the named FHIR operation (e.g., $expunge) on the resource. This tool returns a FHIR OperationOutcome describing success or failure of the deletion.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The FHIR resource type name. Must exactly match one of the resource types supported by the server. | |
| id | No | The logical ID of a specific FHIR resource instance. | |
| searchParam | No | A mapping of FHIR search parameter names to their desired values. These parameters refine queries for operation-specific query qualifiers. Only parameters exposed by `get_capabilities` for that resource type are valid. | |
| operation | No | The name of a custom FHIR operation or extended query defined for the resourceMust match one of the operation names returned by `get_capabilities`. |
Implementation Reference
- src/fhir_mcp_server/server.py:610-695 (handler)The `delete` function is the handler that implements the FHIR delete interaction for the MCP server. It validates the input type, ID/search parameters, executes the deletion using an asynchronous FHIR client, and returns an OperationOutcome or resource bundle.
async def delete( type: Annotated[ str, Field( description="The FHIR resource type name. Must exactly match one of the resource types supported by the server.", examples=["ServiceRequest", "Appointment", "HealthcareService"], ), ], id: Annotated[ str, Field(description="The logical ID of a specific FHIR resource instance."), ] = "", searchParam: Annotated[ Dict[str, str | List[str]], Field( description=( "A mapping of FHIR search parameter names to their desired values. " "These parameters refine queries for operation-specific query qualifiers. " "Only parameters exposed by `get_capabilities` for that resource type are valid. " ), examples=['{"category": "laboratory", "status": ["active"]}'], ), ] = {}, operation: Annotated[ str, Field( description=( "The name of a custom FHIR operation or extended query defined for the resource" "Must match one of the operation names returned by `get_capabilities`." ), examples=["$expand"], ), ] = "", ) -> Annotated[ Dict[str, Any], Field( description="A dictionary containing the confirmation of deletion or details on why deletion failed." ), ]: try: logger.debug( f"Invoked with type='{type}', id={id}, searchParam={searchParam}, and operation={operation}" ) if not type: logger.error( "Unable to perform delete operation: 'type' is a mandatory field." ) return await get_operation_outcome_required_error("type") if not id and not searchParam: logger.error( "Unable to perform delete operation: 'id' or 'searchParam' is required." ) return await get_operation_outcome_required_error("id") client: AsyncFHIRClient = await get_async_fhir_client() bundle = await client.resource(resource_type=type, id=id).execute( operation=operation or "", method="DELETE", params=searchParam ) if isinstance(bundle, Dict): return await get_bundle_entries(bundle=bundle) return await get_operation_outcome( severity="information", code="SUCCESSFUL_DELETE", diagnostics="Successfully deleted resource(s).", ) except ValueError as ex: logger.exception( f"User does not have permission to perform FHIR '{type}' resource delete operation. Caused by, ", exc_info=ex, ) return await get_operation_outcome( code="forbidden", diagnostics=f"The user does not have the rights to perform delete operation.", ) except OperationOutcome as ex: logger.exception( f"FHIR server returned an OperationOutcome error while deleting the resource: '{type}', Caused by,", exc_info=ex, ) return ex.resource["issue"] or await get_operation_outcome_exception() except Exception as ex: logger.exception( f"An unexpected error occurred during the FHIR delete operation for resource: '{type}'. Caused by, ", exc_info=ex, ) return await get_operation_outcome_exception() - src/fhir_mcp_server/server.py:600-609 (registration)The `delete` tool is registered using the `@mcp.tool` decorator, which defines its documentation and metadata for the MCP server.
@mcp.tool( description=( "Execute a FHIR `delete` interaction on a specific resource instance. " "Use this tool when you need to remove a single resource identified by its logical ID or optionally filtered by search parameters. " "The optional `id` parameter must match an existing resource instance when present. " "If you include `searchParam`, the server will perform a conditional delete, deleting the resource only if it matches the given criteria. " "If you supply `operation`, it will execute the named FHIR operation (e.g., `$expunge`) on the resource. " "This tool returns a FHIR `OperationOutcome` describing success or failure of the deletion." ) )