Example Parameters - DocumentReference Revoke (Instance Invocation)

Use this example when invoking the $revoke operation at DocumentReference instance level. The target DocumentReference is identified by its logical id in the request URL, so documentIdentifier is not included.

  • Overview
  • Table
  • XML
  • JSON
Parameters
Parameters.id[0]Example-CDR-Parameters-DocumentReference-Revoke-Instance
Parameters.parameter[0].name[0]source
Parameters.parameter[0].resource[0].identifier[0].system[0]https://fhir.nhs.wales/Id/application-instance-identifier
Parameters.parameter[0].resource[0].identifier[0].value[0]210
Parameters.parameter[0].resource[0].deviceName[0].name[0]Welsh Clinical Portal
Parameters.parameter[0].resource[0].deviceName[0].type[0]user-friendly-name
Parameters.parameter[1].name[0]timestamp
Parameters.parameter[1].value[0]2026-08-24T10:30:00Z
Parameters.parameter[2].name[0]revoker
Parameters.parameter[2].resource[0].identifier[0].system[0]https://fhir.hl7.org.uk/Id/gmc-number
Parameters.parameter[2].resource[0].identifier[0].value[0]9630339
Parameters.parameter[2].resource[0].name[0].family[0]Jones
Parameters.parameter[2].resource[0].name[0].given[0]Anne
Parameters.parameter[2].resource[0].name[0].prefix[0]Dr
Parameters.parameter[3].name[0]revocationReason
Parameters.parameter[3].value[0]Clinician has determined that the document is incorrect and should be removed from the patient record.
<Parameters xmlns="http://hl7.org/fhir">
<id value="Example-CDR-Parameters-DocumentReference-Revoke-Instance" />
<parameter>
<name value="source" />
<resource>
<Device>
<identifier>
<system value="https://fhir.nhs.wales/Id/application-instance-identifier" />
<value value="210" />
</identifier>
<deviceName>
<name value="Welsh Clinical Portal" />
<type value="user-friendly-name" />
</deviceName>
</Device>
</resource>
</parameter>
<parameter>
<name value="timestamp" />
<valueDateTime value="2026-08-24T10:30:00Z" />
</parameter>
<parameter>
<name value="revoker" />
<resource>
<Practitioner>
<identifier>
<system value="https://fhir.hl7.org.uk/Id/gmc-number" />
<value value="9630339" />
</identifier>
<name>
<family value="Jones" />
<given value="Anne" />
<prefix value="Dr" />
</name>
</Practitioner>
</resource>
</parameter>
<parameter>
<name value="revocationReason" />
<valueString value="Clinician has determined that the document is incorrect and should be removed from the patient record." />
</parameter>
</Parameters>
{
"resourceType": "Parameters",
"id": "Example-CDR-Parameters-DocumentReference-Revoke-Instance",
"parameter": [
{
"name": "source",
"resource": {
"resourceType": "Device",
"identifier": [
{
"system": "https://fhir.nhs.wales/Id/application-instance-identifier",
"value": "210"
}
],
"deviceName": [
{
"name": "Welsh Clinical Portal",
"type": "user-friendly-name"
}
]
}
},
{
"name": "timestamp",
"valueDateTime": "2026-08-24T10:30:00Z"
},
{
"name": "revoker",
"resource": {
"resourceType": "Practitioner",
"identifier": [
{
"system": "https://fhir.hl7.org.uk/Id/gmc-number",
"value": "9630339"
}
],
"name": [
{
"family": "Jones",
"given": [
"Anne"
],
"prefix": [
"Dr"
]
}
]
}
},
{
"name": "revocationReason",
"valueString": "Clinician has determined that the document is incorrect and should be removed from the patient record."
}
]
}