The DeleteDocumentSet method provides the ability for the recipient to delete a received referral from their account. The delete operation is part logical and part physical with the binary attachments being physically deleted from the data store with the parent referral entity being logically marked as deleted.

In order for the method to successfully delete a documentSet the following conditions must be satisfied:

  • The user initiating the delete request is the recipient and thus the ultimate owner of the referral.
  • The users' account is enabled and / or their subscription has not expired (optional).
  • The referral has not previously been marked as deleted.
  • The target network implementation acknowledges and honours the delete request.
<DeleteDocumentRequest xmlns="urn:global-health:referralnet">urn:1197fadi</DeleteDocumentRequest>

If the DeleteDocumentSet operation was successful, the below response fragment is returned.

<ns3:RegistryResponse status="Success" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
      <ns1:Slot name="size" xmlns:ns1="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0">
      <ns1:Slot name="uid" xmlns:ns1="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0">
      <ns1:Slot name="date-time" xmlns:ns1="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0">
            <ns1:Value>November 3, 2008 2:34:40 PM WST</ns1:Value>

If the DeleteDocumentSet operation is not successful, the response stream is as below.

<ns3:RegistryResponse status="Failure" xmlns:ns3="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
      <ns3:RegistryError codeContext="Failed to locate documentSet with id urn:1197fadi" 
dev/refnet_delete.txt · Last modified: 2009/01/20 00:12 by byron