Example DocumentReference - Revoked

This DocumentReference example illustrates the revocation of a document as described in the document error workflow guidance. It shows the effect on the DocumentReference resource of an individual marking a document as revoked.

  • Overview
  • Table
  • XML
  • JSON
DocumentReference
DocumentReference.id[0]Example-DataStandardsWales-DocumentReference-Revoked
DocumentReference.meta[0].versionId[0]2
DocumentReference.meta[0].lastUpdated[0]2026-07-12T12:00:10+00:00
DocumentReference.meta[0].source[0]urn:oid:2.16.840.1.113883.2.1.8.1.5.210
DocumentReference.meta[0].profile[0]https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-DocumentReference
DocumentReference.meta[0].tag[0].system[0]seqno
DocumentReference.meta[0].tag[0].display[0]1
DocumentReference.meta[0].tag[1].system[0]docattr_documenttypecode
DocumentReference.meta[0].tag[1].display[0]FCP_RBID
DocumentReference.meta[0].tag[2].system[0]docattr_documentsubcategorycode
DocumentReference.meta[0].tag[2].display[0]DSCNCODE
DocumentReference.meta[0].tag[3].system[0]docattr_duplicate
DocumentReference.meta[0].tag[3].display[0]false
DocumentReference.meta[0].tag[4].system[0]errorstatus
DocumentReference.meta[0].tag[4].code[0]revoked
DocumentReference.meta[0].tag[4].display[0]Revoked
DocumentReference.extension[0].url[0]https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DocumentDigitalStatus
DocumentReference.extension[0].value[0]born-digital-document
DocumentReference.extension[1].url[0]http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
DocumentReference.extension[1].value[0]1
DocumentReference.identifier[0].system[0]https://fhir.nhs.wales/Id/document-identifier
DocumentReference.identifier[0].value[0]318D516B-A3A3-4171-BF15-353001AF49E7
DocumentReference.identifier[1].system[0]https://fhir.nhs.wales/Id/supersession-set-identifier
DocumentReference.identifier[1].value[0]E08B8E00-8CBB-4DDB-BCF7-67E1972A2E60
DocumentReference.status[0]entered-in-error
DocumentReference.docStatus[0]final
DocumentReference.type[0].coding[0].system[0]http://snomed.info/sct
DocumentReference.type[0].coding[0].code[0]2570241000000100
DocumentReference.type[0].coding[0].display[0]FCP-RBID (Future Care Planning Record of Agreed Best Interests Decisions) form
DocumentReference.category[0].coding[0].system[0]http://snomed.info/sct
DocumentReference.category[0].coding[0].code[0]822761000000108
DocumentReference.category[0].coding[0].display[0]Patient preferences record
DocumentReference.subject[0].reference[0]Patient/Example-DataStandardsWales-Patient-HaroldJames
DocumentReference.subject[0].display[0]JAMES, Harold A, Mr
DocumentReference.date[0]2025-08-26T12:14:59+00:00
DocumentReference.author[0].reference[0]Practitioner/Example-DSW-Practitioner-Nurse-EmilyMay
DocumentReference.author[0].display[0]MAY, Emily B, Ms (NMC:AB12345X)
DocumentReference.custodian[0].reference[0]Organization/Example-DataStandardsWales-Organization-HDUHB
DocumentReference.custodian[0].display[0]Hywel Dda University Health Board
DocumentReference.description[0]Future Care Planning Record of Agreed Best Interests Decisions
DocumentReference.securityLabel[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-Confidentiality
DocumentReference.securityLabel[0].coding[0].code[0]N
DocumentReference.securityLabel[0].coding[0].display[0]Normal
DocumentReference.content[0].attachment[0].contentType[0]application/pdf
DocumentReference.content[0].attachment[0].language[0]eng
DocumentReference.content[0].attachment[0].url[0]https://www.example.com/documentref9876
DocumentReference.context[0].period[0].start[0]2025-08-26
DocumentReference.context[0].practiceSetting[0].coding[0].system[0]http://snomed.info/sct
DocumentReference.context[0].practiceSetting[0].coding[0].code[0]310140004
DocumentReference.context[0].practiceSetting[0].coding[0].display[0]Cardiothoracic surgery service
DocumentReference.context[0].related[0].reference[0]Organization/Example-DataStandardsWales-Organization-HDUHB
DocumentReference.context[0].related[0].display[0]Hywel Dda University Health Board
DocumentReference.context[0].related[1].reference[0]Location/Example-DataStandardsWales-Location-GGH
DocumentReference.context[0].related[1].display[0]Glangwili General Hospital
DocumentReference.context[0].related[2].reference[0]Practitioner/Example-DSW-Practitioner-Consultant-JoeBloggs
DocumentReference.context[0].related[2].display[0]BLOGGS, Joe A, Dr (GMC:1234567)
<DocumentReference xmlns="http://hl7.org/fhir">
<id value="Example-DataStandardsWales-DocumentReference-Revoked" />
<meta>
<versionId value="2" />
<lastUpdated value="2026-07-12T12:00:10+00:00" />
<source value="urn:oid:2.16.840.1.113883.2.1.8.1.5.210" />
<profile value="https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-DocumentReference" />
<tag>
<system value="seqno" />
<display value="1" />
</tag>
<tag>
<system value="docattr_documenttypecode" />
<display value="FCP_RBID" />
</tag>
<tag>
<system value="docattr_documentsubcategorycode" />
<display value="DSCNCODE" />
</tag>
<tag>
<system value="docattr_duplicate" />
<display value="false" />
</tag>
<tag>
<system value="errorstatus" />
<code value="revoked" />
<display value="Revoked" />
</tag>
</meta>
<extension url="https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DocumentDigitalStatus">
<valueCode value="born-digital-document" />
</extension>
<extension url="http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version">
<valueString value="1" />
</extension>
<identifier>
<system value="https://fhir.nhs.wales/Id/document-identifier" />
<value value="318D516B-A3A3-4171-BF15-353001AF49E7" />
</identifier>
<identifier>
<system value="https://fhir.nhs.wales/Id/supersession-set-identifier" />
<value value="E08B8E00-8CBB-4DDB-BCF7-67E1972A2E60" />
</identifier>
<status value="entered-in-error" />
<docStatus value="final" />
<type>
<coding>
<system value="http://snomed.info/sct" />
<code value="2570241000000100" />
<display value="FCP-RBID (Future Care Planning Record of Agreed Best Interests Decisions) form" />
</coding>
</type>
<category>
<coding>
<system value="http://snomed.info/sct" />
<code value="822761000000108" />
<display value="Patient preferences record" />
</coding>
</category>
<subject>
<reference value="Patient/Example-DataStandardsWales-Patient-HaroldJames" />
<display value="JAMES, Harold A, Mr" />
</subject>
<date value="2025-08-26T12:14:59+00:00" />
<author>
<reference value="Practitioner/Example-DSW-Practitioner-Nurse-EmilyMay" />
<display value="MAY, Emily B, Ms (NMC:AB12345X)" />
</author>
<custodian>
<reference value="Organization/Example-DataStandardsWales-Organization-HDUHB" />
<display value="Hywel Dda University Health Board" />
</custodian>
<description value="Future Care Planning Record of Agreed Best Interests Decisions" />
<securityLabel>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality" />
<code value="N" />
<display value="Normal" />
</coding>
</securityLabel>
<content>
<attachment>
<contentType value="application/pdf" />
<language value="eng" />
<url value="https://www.example.com/documentref9876" />
</attachment>
</content>
<context>
<period>
<start value="2025-08-26" />
</period>
<practiceSetting>
<coding>
<system value="http://snomed.info/sct" />
<code value="310140004" />
<display value="Cardiothoracic surgery service" />
</coding>
</practiceSetting>
<related>
<reference value="Organization/Example-DataStandardsWales-Organization-HDUHB" />
<display value="Hywel Dda University Health Board" />
</related>
<related>
<reference value="Location/Example-DataStandardsWales-Location-GGH" />
<display value="Glangwili General Hospital" />
</related>
<related>
<reference value="Practitioner/Example-DSW-Practitioner-Consultant-JoeBloggs" />
<display value="BLOGGS, Joe A, Dr (GMC:1234567)" />
</related>
</context>
</DocumentReference>
{
"resourceType": "DocumentReference",
"id": "Example-DataStandardsWales-DocumentReference-Revoked",
"meta": {
"versionId": "2",
"lastUpdated": "2026-07-12T12:00:10+00:00",
"source": "urn:oid:2.16.840.1.113883.2.1.8.1.5.210",
"profile": [
"https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-DocumentReference"
],
"tag": [
{
"system": "seqno",
"display": "1"
},
{
"system": "docattr_documenttypecode",
"display": "FCP_RBID"
},
{
"system": "docattr_documentsubcategorycode",
"display": "DSCNCODE"
},
{
"system": "docattr_duplicate",
"display": "false"
},
{
"system": "errorstatus",
"code": "revoked",
"display": "Revoked"
}
]
},
"extension": [
{
"url": "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DocumentDigitalStatus",
"valueCode": "born-digital-document"
},
{
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version",
"valueString": "1"
}
],
"identifier": [
{
"system": "https://fhir.nhs.wales/Id/document-identifier",
"value": "318D516B-A3A3-4171-BF15-353001AF49E7"
},
{
"system": "https://fhir.nhs.wales/Id/supersession-set-identifier",
"value": "E08B8E00-8CBB-4DDB-BCF7-67E1972A2E60"
}
],
"status": "entered-in-error",
"docStatus": "final",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "2570241000000100",
"display": "FCP-RBID (Future Care Planning Record of Agreed Best Interests Decisions) form"
}
]
},
"category": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "822761000000108",
"display": "Patient preferences record"
}
]
}
],
"subject": {
"reference": "Patient/Example-DataStandardsWales-Patient-HaroldJames",
"display": "JAMES, Harold A, Mr"
},
"date": "2025-08-26T12:14:59+00:00",
"author": [
{
"reference": "Practitioner/Example-DSW-Practitioner-Nurse-EmilyMay",
"display": "MAY, Emily B, Ms (NMC:AB12345X)"
}
],
"custodian": {
"reference": "Organization/Example-DataStandardsWales-Organization-HDUHB",
"display": "Hywel Dda University Health Board"
},
"description": "Future Care Planning Record of Agreed Best Interests Decisions",
"securityLabel": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N",
"display": "Normal"
}
]
}
],
"content": [
{
"attachment": {
"contentType": "application/pdf",
"language": "eng",
"url": "https://www.example.com/documentref9876"
}
}
],
"context": {
"period": {
"start": "2025-08-26"
},
"practiceSetting": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "310140004",
"display": "Cardiothoracic surgery service"
}
]
},
"related": [
{
"reference": "Organization/Example-DataStandardsWales-Organization-HDUHB",
"display": "Hywel Dda University Health Board"
},
{
"reference": "Location/Example-DataStandardsWales-Location-GGH",
"display": "Glangwili General Hospital"
},
{
"reference": "Practitioner/Example-DSW-Practitioner-Consultant-JoeBloggs",
"display": "BLOGGS, Joe A, Dr (GMC:1234567)"
}
]
}
}