Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Referencing Transfer of Care Documentation

How do we reference transfer of care documentation?

The NHSC Booking standard specifically does not include any transfer of care information. The booking process typically forms a part of an overall referral workflow and the standard allows for reference to any transfer of care documentation that might be sent.

The intention is to allow the booking message to include a reference to any referral document (e.g. 111CDA, Kettering, and FHIR documents) and in the FHIR profile for an appointment it is possible to add this reference, this is detailed in the Message Specification .

The reference is in the form of a contained FHIR document reference resource. This resource allows the reference to be made in a standardised and structured way.

Ideally the referral documentation will also include a reference to the appointment too. This will then allow for cross referencing which will help with the asynchronous relationship between the booking and referral messages. Depending on use case, the referral documentation may be sent first, at the same time or after the appointment message. In the cases where the appointment is created before the referral document, the reference to the booking would have to be included to allow them to be matched by the appointment provider.

The intention is that any standards that govern referral messaging and documentation will include references to appointments in due course.

How this might work in practice

Below is an example of how one type of transfer of care process can be linked with appointment booking.

In this illustration we have a referral from 111 using a 111CDA document containing a coded entry which holds the appointment reference / identifier and the second example shows a coded section heading which holds a text representation of appointment details.

<entry typeCode="COMP" contextConductionInd="true">
	<npfitlc:contentId root="2.16.840.1.113883.2.1.3.2.4.18.16" extension="COCD_TP146093GB01#AppointmentReference"/>
	<encounter classCode="ENC" moodCode="APT">
		<templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="COCD_TP146093GB01#AppointmentReference"/>
		<id root="2.16.840.1.113883.2.1.3.2.4.17.541" extension="https://<generic-address-here>/fhir/Appointment/28BCD0FC-F01F-4DB2-B6F1-92A36A37B348/"/>
		<code code="01" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.542" displayName="Patient convenience appointment"/>
		<effectiveTime value="201706011400+00"/>
	</encounter>
</entry>

Key to the linking is the encounter component, specifically the extension element of id, where the appointment URL is specified. This is where the appointment reference should be taken from. The appointment URL (including reference) may be set in the href attribute and the reference can be obtained from the href attribute but must not be taken from the “text-between-the-tags”.

<component typeCode="COMP" contextConductionInd="true">
    <npfitlc:contentId extension="COCD_TP146246GB01#Section1" root="2.16.840.1.113883.2.1.3.2.4.18.16"/>
    <section classCode="DOCSECT" moodCode="EVN">
        <templateId extension="COCD_TP146246GB01#Section1" root="2.16.840.1.113883.2.1.3.2.4.18.2"/>
       <id root="90611FD4-6616-11EB-B9BD-00155D70280A"/>
        <title>Booked appointment with 'service name' on 'date' at 'time'</title>
        <text>
            <linkHtml href="https://<generic-address-here>/fhir/Appointment/28BCD0FC-F01F-4DB2-B6F1-92A36A37B348/">https://NHSD.Test.INT.nhs.uk/fhir/Appointment/28BCD0FC-F01F-4DB2-B6F1-92A36A37B348</linkHtml>
        </text>
    </section>
</component>

The process for being able to link the two together is complicated by the fact that the identifier for the CDA is created by the Consumer, while the identifier for the Appointment is created by the Provider. As a result of this, the following process needs to be followed:

  • Generate the UUID to be used as the identity of the CDA
  • Generate the Appointment resource
  • Insert the UUID from #1 into the Appointment resource.
  • POST the Appointment, response has a Location header that gives the URL of the saved Appointment.
  • Ensure the URL is a fully qualified, (so starting with https:// etc not just /Appointment/xxx-yyy-1234- etc).
  • Complete the CDA generation as normal.
  • Add the URL into the CDA as shown above.

It must be noted, CDA messages offer operations which the Booking Standard does not support. 111CDA allows for a message to be replaced, the new message superceding the original as the most clinically relevant, rendering the original out-of-date and not to be used for clinical decision making.

The process of replacing CDAs is usually acceptable, the documents are versioned and all must be stored by the receiver, providing a complete audit history. However, when a booking is made, it includes reference to a specific CDA document which, if the replace operation is performed, no longer exists as a clinically relevant document.

Provider Requirements

On receipt, the Provider must then do the following:

  1. First receive booking
  2. Lookup / Create the Patient
  3. Create case
  4. Create booking- with the reference to the CDA document within it
  5. (Return the URL to the booking in the Location header)
  6. Receive the CDA message over ITK (or email)
  7. Find matched cases based on ID of the CDA->Appointment.DocumentReference.identifier
  8. Merge CDA into case - save against the record so that the CDA information is easily accessible by a clinician against the case when the patient attends the booking.

All content is available under the Open Government Licence v3.0, except where otherwise stated