Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

ITK3 header requirements

Details of how the ITK3 header is populated to fulfil the Consultation Summary 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 can be populated in all instances of messages generated by sending systems:

GPCM-SD-CS-043 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-CS-044 BusAckRequested MUST be set to fixed value of true. This will request an ITK3 Response with a response code in the range 30001 to 30003.

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-045 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-CS-046 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-CS-047 MessageDefinition MUST be set to fixed value of https://fhir.nhs.uk/STU3/MessageDefinition/ITK-GPConnectSendDocument-MessageDefinition-1

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-048 LocalExtension MUST be set to fixed value of SendDocument-ConsultationReport

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-049 Sender MUST contain a reference to the CareConnect-ITK-Header-Organization-1 resource present in the FHIR message bundle
GPCM-SD-CS-050 Source MUST contain the MESH mailbox ID of the sender
GPCM-SD-CS-051 Event MUST contain a fixed value of ITK007C from code system ITK-MessageEvent-2
GPCM-SD-CS-052 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-CS-053 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 registered practice as an ITK Response:

GPCM-SD-CS-054 BusAckRequested MUST contain a fixed value of false

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-055 InfAckRequested MUST contain a fixed value of false

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-056 SenderReference MUST contain the same unique identifier generated by GPCM-SD-042.

This item is found in the ITKMessageHandling extension within the ITK3 Message Header
GPCM-SD-CS-057 Sender MUST contain a reference to an CareConnect-ITK-Header-Organization-1 resource present in the FHIR message bundle
GPCM-SD-CS-058 Event MUST contain a fixed value of ITK008M from code system ITK-MessageEvent-2
GPCM-SD-CS-059 Timestamp MUST contain the date/time when the response was generated.

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