Details of how the ITK3 header is populated to fulfil the Online Consultation Report use case
Please refer to Using ITK3 to support GP Connect Messaging for an overview of the use of ITK3 in this context.
Requirements are given below which define how the ITK3 Message Header is populated in all instances of messages generated by sending organisations for this use case:
| GPCM-SD-OC-141 | when sending to the primary recipient (the care provider expected to action the message) the RecipientType MUST be set to fixed value of FA ('For action') taken from FHIR ValueSet ITK-RecipientType-1 The meaning of RecipientType is applied in a common way across all ITK3 messaging. "For action" in this case indicates that the recipient is expected to take action. This item is found in the ITKMessageHandling extension within the ITK3 Message Header. |
| GPCM-SD-OC-142 | when sending a copy message to the patient's registered GP practice the RecipientType MUST be set to fixed value of FI ('For information') taken from FHIR ValueSet ITK-RecipientType-1 "For information" in this case indicates that the recipient is not expected to take action but should attach the payload contents to the patient record. This item is found in the ITKMessageHandling extension within the ITK3 Message Header. |
| GPCM-SD-OC-143 | BusAckRequested MUST be set to fixed value of true. This will request an ITK3 Response with a response code in the range 30001 to 30018.This item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-144 | InfAckRequested MUST be set to fixed value of true. This will request an ITK3 Response with a response code in the range 10001 to 20013.This item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-145 | SenderReference MUST be set to the unique identifier of the encounter which has taken place at the sender organisation.This item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-146 | MessageDefinition MUST be set to fixed value of https://fhir.nhs.uk/STU3/MessageDefinition/ITK-GPConnectSendDocument-MessageDefinition-1This item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-147 | LocalExtension MUST be set to fixed value of SendDocument-OnlineConsultationReportThis item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-148 | Sender MUST contain a reference to the CareConnect-ITK-Header-Organization-1 resource present in the FHIR message bundle |
| GPCM-SD-OC-149 | Source MUST contain the MESH mailbox ID of the sender |
| GPCM-SD-OC-150 | Event MUST contain a fixed value of ITK007C from code system ITK-MessageEvent-2 |
| GPCM-SD-OC-151 | Timestamp MUST contain the date/time when the message was generated. (A separate process such as the MESH client may be responsible for sending the message at a later date/time.) |
The following table indicates those elements which will not be present in the ITK3 Message Header:
| GPCM-SD-OC-152 | destination and receiver MUST NOT be present. Rather, MESH message routing will be used to route message to registered GP practice by NHS Number, DOB and Surname |
ITK3 responses generated
The following specific requirements describe how the ITK3 Message Header is to be populated in all instances of messages generated by the receiving organisation as an ITK Response:
| GPCM-SD-OC-153 | BusAckRequested MUST contain a fixed value of falseThis item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-154 | InfAckRequested MUST contain a fixed value of falseThis item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-155 | SenderReference MUST contain the same unique identifier generated by GPCM-SD-OC-145.This item is found in the ITKMessageHandling extension within the ITK3 Message Header |
| GPCM-SD-OC-156 | Sender MUST contain a reference to an CareConnect-ITK-Header-Organization-1 resource present in the FHIR message bundle |
| GPCM-SD-OC-157 | Event MUST contain a fixed value of ITK008M from code system ITK-MessageEvent-2 |
| GPCM-SD-OC-158 | Timestamp MUST contain the date/time when the response was generated. |
ITK3 responses codes
The following requirements specify the ITK Response codes associated with Online Consultations send to alternation care provider pilot:
| GPCM-SD-OC-169 | the ITK-ResponseCodes-1 business acknowledgements codes 30001 to 30018 MUST be supported. These codes are listed below: |
| Code | Description |
|---|---|
| 30001 | Patient known here. (e.g. Patient is registered here) |
| 30002 | Patient not known here. (aka ‘patient record not present in system’) |
| 30003 | Patient no longer at this clinical setting |
| 30004 | Patient known here and recently deceased (i.e. patient record current in GP practice system at time of patient’s death and deduction subsequently occurred for this reason) |
| 30005 | Referral open |
| 30006 | Referral completed |
| 30007 | Referral escalated back to GP |
| 30008 | Signposting to GP (non-urgent) |
| 30009 | Clinical escalation to UTC/111/GPOOH |
| 30010 | Clinical escalation to A&E or 999 |
| 30011 | Advised to go elsewhere/self-referral |
| 30012 | Unable to contact the patient |
| 30013 | Closure (service not needed) |
| 30014 | Closure (service not accepted) |
| 30015 | Closure (duplicate referral) |
| 30016 | Referral accepted |
| 30017 | Referral rejected |
| 30018 | Did Not Attend |
