Please refer to Send Document - Payload structure for a definition of the payload structure to be used to fulfil the Send Federated Consultation Report use case.
The following sections describe the resources which form the payload. i.e. the resources which will be present as entries of the ITK-Payload-Bundle resource which acts as a container for the payload.
A message example is provided which illustrates these requirements to aid understanding.
Task resource
| GPCM-SD-14 | A Task resource profiled to https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Task-1 resource MUST be present in the payload |
The following requirements describe how the Task resource is populated:
| GPCM-SD-15 | intent MUST contain fixed value plan |
| GPCM-SD-16 | status MUST contain fixed value requested |
| GPCM-SD-17 | priority MUST contain fixed value: routine Where a specific action beyond attachment to the patient record at the registered practice is expected or required, existing business processes should be used as the Send Federated Consultation Report use case is simply the act of synchronising with the registered patient record. When the GP Connect Send Task capability has been implemented, this could be used to request specific tasks to raised at the registered practice beyond attachment to the registered practice record. |
| GPCM-SD-18 | description MUST contain a summary of request in the following format:Federated consultation report for {Patient Name} , NHS Number {NHS Number}, seen at {Practice Name}, ODS Code {ODS Code} |
| GPCM-SD-19 | for MUST contain a reference to Patient resource profiled to CareConnect-Patient-1 |
| GPCM-SD-20 | authoredOn 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.) |
| GPCM-SD-21 | requester.agent MUST contain a reference to a federated practice Practitioner resource profiled to CareConnect-Practitioner-1 |
| GPCM-SD-22 | requester.onBehalfOf MUST contain a reference to a federated practice Organization resource profiled to CareConnect-Organization-1 |
| GPCM-SD-23 | owner MUST contain a reference to a registered practice Organization resource profiled to CareConnect-Organization-1 |
Including binary documents in the payload
Send Document - Including documents in the payload defines how binary documents are included in the Send Document payload.
For this use case, the following specific requirements apply:
Federated Consultation Report
| GPCM-SD-24 | The input element MUST contain a binary document which provides a report of the federated consultation in PDF format. |
| GPCM-SD-25 | input.type.text MUST be a fixed value of Federated consultation report |
| GPCM-SD-26 | The referenced https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-DocumentReference-1 resource MUST contain a description element set to a fixed value of Federated Consultation Report |
Additional input elements
Message senders MAY include additional binary documents in the payload as each expressed as an additional instance of the task.input as described in Send Document - payload structure
| GPCM-SD-27 | Where binary documents are included in the payload in addition to the Federated Consulation Report, the Message receiver MUST process these according ensuring all attachments remain in the context of the enounter information delivered to downstream systems. |
Organization resources
| GPCM-SD-28 | As described in Send Document - Payload structure, the payload MUST contain an organization resource describing both the sending organisation (the federated practice) and the receiving organisation (the patient's registered practice) |
The table below outlines how these resources are populated:
| GPCM-SD-29 | The odsOrganisationCode slice of the identifier element MUST contain the ODS code |
| GPCM-SD-30 | The name element MUST contain the name of the organisation |
| GPCM-SD-31 | The telecom element MUST contain the telephone number of that organization. i.e. where telecom.system is set to a fixed value of phone, and telecom.value contains the telephone number |
Practitioner resource
The CareConnect-Practitioner-1 resource present in the payload is populated as follows:
| GPCM-SD-32 | The SDS User ID of the practitioner MUST be present in the sdsUserID slice of the identifier element |
| GPCM-SD-33 | The name of the practitioner MUST be present in the single instance of the name element where name.use is set to official |
| GPCM-SD-34 | Telephone contact details MUST be present if available in the Telecom element. i.e. telecom.system is set to a fixed value of phone, and telecom.value contains the telephone number |
Patient resource
The CareConnect-Patient-1 in the payload is populated as follows:
| GPCM-SD-35 | The NHS Number of the patient MUST be specified in the nhsNumber slice of the identifier element |
| GPCM-SD-36 | The name of the patient MUST be present in the single instance of the name element where name.use is set to official |
| GPCM-SD-37 | The date of birth of the patient MUST be specified in YYYY-MM-DD format in the birthDate element. Birth time is not required. |
| GPCM-SD-38 | Values specified in the patient resource for surname, date of birth and NHS Number MUST match those specified in MESH metadata To_DTS field (for the MESH client) or Mex_To (for the MESH API) as described in MESH message configuration |
