Sending a .pdf Document Requiring an Acknowledgement
Scenario
The "Anytown General Hospital" needs to send a Discharge Summary, which they produce in .pdf format for the now completed in-patient stay for Mrs. Smith. Mrs. Smith has been discharged from the care of the Oncology team in the hospital. The Discharge Summary needs to be delivered to Mrs. Smith's General Practice "The Surgery, Townville", and in particular to her regular General Practitioner Dr. Brown. It is the hospital's practice to request both an infrastructure acknowledgement and business acknowledgement from GP practices to show that Discharge Summaries have been received into the GP practice system.
Codes used in this example
- Anytown General Hospital has an Organisation Data Service (ODS) code of "R59"
- The Surgery, Townville has an ODS code of "Y88764"
- Dr. Brown has a General Medical Council code of "G1234567"
- Mrs. Smith's NHS Number is "2345678901"
Acknowledgement related handling specifications
- urn:nhs-itk:ns:201005:infackrequested set to "true"
- urn:nhs-itk:ns:201005:ackrequested set to "true"
- urn:nhs-itk:ns:201005:busresponserequested set to "false"
Creating the distribution envelope for a .pdf document transmission requiring an acknowledgement
The .pdf document has been created by an author working for the Oncology team for Anytown General Hospital, it has been attested to, and is ready for transmission to Mrs. Smith's General Practice (in particular Dr. Brown).
Completing the Distribution Envelope
For a description of the Distribution Envelope elements and attributes click here
| Name | Notes | Value |
| header | ||
| @Service | As Anytown General Hospital is sending a transmission over ITK, they must choose an appropriate service under which to send the transmission. "SendDocument-v1-0" is the service that should be used to transmit this .pdf documents, as it is not a CDA document. | urn:nhs-itk:services:21005:SendDocument-v1-0 |
| @trackingid | A UUID for the transmission | 7D6D9D40-AE1A-11DB-97F8-B18E1E0666AA |
| addresslist | ||
| address | ||
| @type | The default address type is used in this example, so this attribute is omitted | Intentionally blank |
| @uri | The ITK compliant address of Mrs Smith's GP (GMC number of G1234567), to whom the document is destined. | urn:nhs-uk:addressing:ods:Y88764:G1234567 |
| auditIdentity | ||
| id | ||
| @type | The default address type is used in this example, so this attribute is omitted | Intentionally blank |
| @uri | The address on the Oncology team working for Anytown General Hospital (ODS code R59), who originated the document | urn:nhs-uk:identity:ods:R59:oncology |
| manifest | ||
| @count | A count of the manifests. In this case a single document | 1 |
| manifestitem | ||
| @id | The identifier of the document payload | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E8888BB |
| @mimetype | The mime type of the document. | application/pdf |
| @profileid | As no profile is available for this document type, this attribute is omitted | Intentionally blank |
| @metadata | As this isn't a metadata payload, this attribute is defaulted to false and omitted | Intentionally blank |
| @compressed | As this payload isn't compressed, this attribute is defaulted to false and omitted | Intentionally blank |
| @base64 | As this payload is a binary in base64 object, this attribute is set to "true" | true |
| @encrypted | As this payload isn't encrypted, this attribute is defaulted to false and omitted | Intentionally blank |
| senderAddress | ||
| @type | The default address type is used in this example, so this attribute is omitted | Intentionally blank |
| @uri | The address on the Oncology team working for Anytown General Hospital (ODS code R59), who originated the document | urn:nhs-uk:addressing:ods:R59:oncology |
| handlingSpecifications | Handling specifications are required to send an infrastructure and business Acknowledgement and for the Discharge report interaction | |
| spec | ||
| @key | Key for Infrastructure ACK to be returned | urn:nhs-itk:ns:201005:infackrequested |
| @value | Value for the key is True | true |
| spec | ||
| @key | Key for Business ACK to be returned | urn:nhs-itk:ns:201005:ackrequested |
| @value | Value for the key is True | true |
| spec | ||
| @key | Key for Business Response to be returned | urn:nhs-itk:ns:201005:busresponserequested |
| @value | Value for the key is False | false |
| payloads | ||
| @count | The number of payloads is just 1 | 1 |
| payload | ||
| @id | The locally assigned UUID for the payload (matches the manifest.id describing this payload) | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E8888BB |
| @filename | As filename is used for payloads such as images, and not meant for documents it is omitted. | Intentionally blank |
Distribution Envelope Instance
The XML instance is shown below.
| Item | |
|---|---|
| The XML file for sending a .pdf Document Requiring an Acknowledgement | View |
