Sending a CDA Document that is both Compressed and Encrypted, Requiring an Acknowledgement
Scenario
The "Anytown General Hospital" needs to send an ITK Discharge Summary 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. The transmission is to be both compressed and encrypted. Metadata is also generated for the correspondence.
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"
- The discharge summary interaction id is "urn:nhs-itk:interaction:primaryRecipienteDischargeInpatientDischargeSummaryDocument-v1-0"
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 CDA document transmission requiring an acknowledgement
The CDA 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
A description of the Distribution Envelope elements and attributes can be found 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. "SendCDADocument-v2-0" is the service that should be used to transmit CDA documents. | urn:nhs-itk:services:201005:SendCDADocument-v2-0 |
| @trackingid | A UUID for the transmission | 7D6D9D40-AE1A-11DB-97F8-B18E1E0994AC |
| 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 CDA 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 CDA document and metadata | 2 |
| manifestitem | ||
| @id | The identifier of the metadata payload | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E0111CC |
| @mimetype | The mime type of the metadata payload | text/xml |
| @profileid | Profile for the discharge summary | Intentionally blank |
| @metadata | As this isn't a metadata payload, this attribute is defaulted to false and omitted | true |
| @compressed | As this payload is compressed, this attribute is true | Intentionally blank |
| @base64 | As this payload isn't in base64, this attribute is defaulted to false and omitted | Intentionally blank |
| @encrypted | As this payload is encrypted, this attribute is true | Intentionally blank |
| manifestitem | ||
| @id | The identifier of the CDA payload | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E0994AD |
| @mimetype | The mime type of the CDA document. | text/xml |
| @profileid | Profile for the discharge summary | urn:nhs-en:profile:eDischargeInpatientDischargeSummary-v1-0 |
| @metadata | As this isn't a metadata payload, this attribute is defaulted to false and omitted | Intentionally blank |
| @compressed | As this payload is compressed, this attribute is true | true |
| @base64 | As this payload isn't in base64, this attribute is defaulted to false and omitted | Intentionally blank |
| @encrypted | As this payload is encrypted, this attribute is true | true |
| 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 summary 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 |
| spec | ||
| @key | Key for the interaction | urn:nhs-itk:ns:201005:interaction |
| @value | Value for the key is the interaction id | urn:nhs-itk:interaction:primaryRecipienteDischargeInpatientDischargeSummaryDocument-v1-0 |
| payloads | ||
| @count | The number of payloads is 2 | 2 |
| payload | ||
| @id | The locally assigned UUID for the metadata payload (matches the manifest.id describing this payload) | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E0111CC |
| @filename | As filename is used for payloads such as images, it is omitted. | Intentionally blank |
| payload | ||
| @id | The locally assigned UUID for the payload (matches the manifest.id describing this payload) | uuid_7D73B7C0-AE1A-11DB-982C-B18E1E0994AD |
| @filename | As filename is used for payloads such as images, and not meant for CDA documents it is omitted. | Intentionally blank |
Distribution Envelope Instance
The XML instance is shown below.
| Item | |
|---|---|
| The XML file for sending a CDA Document that is both Compressed and Encrypted, Requiring an Acknowledgement | View |
