Payload message requirements
The following requirements describe the structure of the Send Document payload:
| GPCM-SD-1 | The ITK3 MessageHeader.focus element MUST be a reference to a Bundle resource which conforms to the ITK-Payload-Bundle profile. |
| GPCM-SD-2 | The ITK-Payload-Bundle MUST contain a Task resource profiled to https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Task-1 base resource. |
| GPCM-SD-3 | The ITK-Payload-Bundle MUST contain an Organization resource which conforms to the CareConnect-Organization-1 profile describing the organisation which sends the message. The Task.requester.OnBehalfOf element MUST contain a reference to this resource. |
| GPCM-SD-4 | The Task.requester.OnBehalfOf element MUST contain a reference to the Organization resource. |
| GPCM-SD-5 | Where the message contains patient information, for example as a result of a healthcare event, a patient resource MUST be present which conforms to the CareConnect-Patient-1 profile. When this patient resource is present, the Task.for element MUST contain a reference to this resource. |
| GPCM-SD-6 | Where the message contains practitioner information, for example as a result of a healthcare event, a practitioner resource MUST be present which conforms to the CareConnect-Practitioner-1 profile. This resource describes the primary practitioner who delivered care. When this practitioner resource is present, the Task.requester.agent element MUST contain a reference to this resource. |
| GPCM-SD-7 | Where the message sender knows the single intended recipient organisation for the message, an Organization resource MUST be present which conforms to the CareConnect-Organization-1 profile, describing the organisation which is the target of the message. The Task.requester.owner element MUST contain a reference to this resource. |
Including documents in the payload
The following requirements describe how binary documents are included in the payload:
| GPCM-SD-8 | Each binary document sent in the payload MUST be included as an instance of the Task.input element |
Each instance of an binary document will be included as follows:
| GPCM-SD-9 | task.input.value MUST be a FHIR Reference containing a reference to a DocumentReference profiled to https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-DocumentReference-1. |
| GPCM-SD-10 | The DocumentReference resource MUST be included as an additional entry in the ITK-Payload-Bundle |
The DocumentReference resource will be specified as follows:
| GPCM-SD-11 | DocumentReference.created attribute MUST contain the date/time when the binary document was created, or if not available, the date/time when the FHIR Message was created. |
| GPCM-SD-12 | DocumentReference.description attribute MUST contain a description of the document, intended for use as an attachment label for the document as it appears in the GP Principal Clinical System workflow user interface. |
| GPCM-SD-13 | Document.content attribute MUST contain a FHIR Attachment resource in which the contentType defines the MIME type of the document, and data contains the binary data of the document in base64 encoded format. |
Identifying the use case
The ITK3 message handling key LocalExtension is used to define the health or social care use case associated with the Send Document message. Please refer to the ITK3 header requirements for your particular use case.
Payload message illustration
The payload of a GP Connect message which uses the Send Document capability MUST have the structure illustrated in the diagram below. (Context for the Send Federated Consultation Report use case is given in parentheses.)
Payload message definition
The FHIR MessageDefinition resource provides a formal, machine-readable definition of a message shared between systems. Please refer to ITK3 Message Definitions for an overview of how MessageDefinition resources are used in ITK3 messages.
The GP Connect Send Document capability has defined a MessageDefinition resource instance which describes the payload of the FHIR Message, as defined on at ITK3 Message Definition Patterns
The Message Definition for the GP Connect Send Document message payload is provided below. This definition can be used by FHIR tools such as FHIR Check to verify that particular instance of a Send Document message is conformant.
