Note: A minor revision has been made to this version of the specification due to issues in some of the guidance.
Full details of changes can be found in the release notes in version 2.0.1-public-beta.
Full details of changes can be found in the release notes in version 2.0.1-public-beta.
Supplier Conformance Assessment List
The Supplier Conformance Assessment List (SCAL) is a technical document which details the requirements for the GP Connect Send Document capability, and others within the GP Connect product suite. It will be provided during the assurance stage of the onboarding; however, for convenience, a complete list of requirements fo this capability can be found in the table below, and downloaded as a pipe-separated "|" CSV.
Note: To open in Microsoft Excel go to the "Data" tab and select "From Text/CSV".
| Identifier | Use case | Type | Link | Description | Item | Test cases | Evidence required |
|---|---|---|---|---|---|---|---|
| GPCM-C-1 | All | General | Using MESH | MESH MUST be used as the message transport mechanism | Using MESH to support GP Connect Messaging | Pre-condition / covered by other tests | Provide details of MESH and ITK3 compliance |
| GPCM-C-2 | All | General | Using ITK3 | All FHIR Messages MUST conform to the ITK3 Message Distribution Standard, v2.9.0 | Using MESH to support GP Connect Messaging | Pre-condition / covered by other tests | Provide details of MESH and ITK3 compliance |
| GPCM-SD-056 | All | General | How to configure MESH | All messages sent for this use-case MUST use MESH automated message routing to ensure that the message is correctly routed to the citizen's registered practice | Using MESH to support GP Connect Messaging | Pre-condition / covered by other tests | Provide details of MESH and ITK3 compliance |
| GPCM-SD-028 | All | General | Profile: CareConnect-Organization-1 | The payload MUST contain a FHIR CareConnect-Organization-1 resource describing the sender organisation (the origiN/Ating practice), ODS code, N/Ame , telephone number | Requirements describing how the Organization resource is populated | GPCM-SD-TST-03 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-032 | All | UI | Profile: CareConnect-Practitioner-1 | The payload SHOULD (if known) contain a FHIR CareConnect-Practitioner-1 resource with the sending practitioner SDS User ID, populated in the sdsUserId slice of the identifier element, official N/Ame, telephone number | Requirements describing how the Practitioner resource is populated | GPCM-SD-TST-03 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-035 | All | General | Profile: CareConnect-Patient-1 | The payload MUST contain a FHIR CareConnect-Patient-1 resource with an NHS number, populated within the nhsNumber slice of the identifier element, official N/Ame, date of birth populated in the format: YYYY-MM-DD within the birthDate element | Requirements describing how the Patient resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-038 | All | General | How to configure MESH | All values, populated in the FHIR CareConnect-Patient-1 resource in the N/Ame, birthDate, and nhsNumber elements MUST match those specified in the MESH message configuration - e.g., MESH API: Mex_To, and MESH Client: To_DTS | Using MESH to support GP Connect Messaging | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-040 | All | General | Extension-ITK-MessageHandling-2.LocalExtension | The payload MUST contain a FHIR Extension-ITK-MessageHandling-2 resource with the value true, populated in the BusAckRequired element. This will request an ITK3 response with a response code in the range: 30001 to 30003 | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-041 | All | General | Extension-ITK-MessageHandling-2.LocalExtension | The payload MUST contain a FHIR Extension-ITK-MessageHandling-2 resource with the value true, populated in the InfAckRequired element. This will request an ITK3 response with a response code in the range: 10001 to 20014 | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-042 | All | General | Extension-ITK-MessageHandling-2.LocalExtension | The payload MUST contain a FHIR Extension-ITK-MessageHandling-2 resource with a unique identifier of the activity which has taken place at the sending organisation, populated within the SenderReference element | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-043 | All | General | Extension-ITK-MessageHandling-2.LocalExtension | The payload MUST contain a FHIR Extension-ITK-MessageHandling-2 resource, populated with a fixed value of https://fhir.nhs.uk/STU3/MessageDefinition/ITK-GPConnectSendDocument-MessageDefinition-Instance-1 within the MessageDefinition element | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-044 | All | General | Extension-ITK-MessageHandling-2.LocalExtension | The payload MUST contain a FHIR Extension-ITK-MessageHandling-2 resource populated with a fixed value of NONE within the LocalExtension element | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-045 | All | General | Profile: CareConnect-ITK-Header-Organization-1 | The payload MUST contain a FHIR CareConnect-ITK-Header-Organization-1 in the ITK-Message-Bundle-1 profile | Requirements describing how the CrareConnect-ITK-Header-Organization-1 profile within the ITK3 Document Bundle is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-046 | All | UI (depending on solution) | Profile: ITK-MessageHeader-2 | The payload MUST contain a FHIR ITK-MessageHeader-2 with the MESH mailbox identifier of the sender, populated within the source element | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-047 | All | General | Profile: ITK-MessageHeader-2 | The payload MUST contain a FHIR ITK-MessageHeader-2, populated with the fixed value of ITK007C from the ITK-MessageEvent-2 code system, within the event element | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-048 | All | General | Profile: ITK-MessageHeader-2 | The payload MUST contain a FHIR ITK-MessageHeader-2 with the date and time of when the message was generated, populated within the timestamp element Note: A separate process (such as the MESH client) may be responsible for sending the message at a later date and time. | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-049 | All | General | Profile: ITK-MessageHeader-2 | The payload SHOULD NOT populate the receiver element in the FHIR ITK-MessageHeader-2 resource, as MESH routing will be used to route the message to the registered GP practice using the patient NHS number, date of birth, and surN/Ame | Requirements describing how the ITKMessageHandling extension within the ITK3 Message Header is populated for send document | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-057 | All | General | How to configure MESH | The Use the following Meshdata ID : <WorkflowId>GPCONNECT_SEND_DOCUMENT</WorkflowId> | Requirement describing Workflow groups and Workflow ID | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-059 | All | UI (depending on solution) | How to configure MESH | From_DTS MUST contain the MESH mailbox ID of the sender of the message (e.g., the origiN/Ating practice) | Requirements describing the use of metadata if using the MESH client to send a message to the MESH server, the .CTL file | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-060 | All | General | How to configure MESH | To_DTS MUST contain the NHS Number, DOB and SurN/Ame of the patient delimited by the underscore "_" character. This eN/Ables automatic routing of the message to the registered GP MESH mailbox | Requirements describing the use of metadata if using the MESH client to send a message to the MESH server, the .CTL file | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-061 | All | General | How to configure MESH | Subject MUST contain To text in the following format: [document-title] for [patient-N/Ame], NHS Number: [nhs-number], seen at [location-N/Ame], [ods-code], Version: [version-number] | Requirements describing the use of metadata if using the MESH client to send a message to the MESH server, the .CTL file | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-062 | All | General | How to configure MESH | Subject MUST contain To text in the following format: [document-title] for [patient-N/Ame], NHS Number: [nhs-number], seen at [location-N/Ame], [ods-code], Version: [version-number] | Requirements describing the use of metadata items are defined in HTTP header fields if using the MESH API for the Send Message API call to send a message to the MESH server | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-063 | All | General | How to configure MESH | Mex-To MUST contain the NHS Number, DOB and SurN/Ame of the patient delimited by the underscore "_" character. This eN/Ables automatic routing of the message to the registered GP MESH mailbox | Requirements describing the use of metadata items are defined in HTTP header fields if using the MESH API for the Send Message API call to send a message to the MESH server | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-064 | All | General | How to configure MESH | Mex-Subject MUST contain To text in the following format: [document-title] for [patient-N/Ame], NHS Number: [nhs-number], seen at [location-N/Ame], [ods-code], Version: [version-number] | Requirements describing the use of metadata items are defined in HTTP header fields if using the MESH API for the Send Message API call to send a message to the MESH server | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-098 | All | General | How to handle updates to documents | Version 1 is the origiN/Al document, and updates to documents sent after the initial document MUST increment by 1 | Requirements describing sending replacement documents | GPCM-SD-TST-08 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-103 | All | General | Profile: ITK-MessageHeader-2 | The payload MUST contain a FHIR ITK-MessageHeader-2 resource, populated with an entry element, containing an ITK-Document-Bundle-1 profile | Requirements describing the structure of the Send Document payload | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-104 | All | General | Profile: ITK-Document-Bundle-1 | The payload MUST contain a FHIR ITK-Document-Bundle-1 resource, populated with an entry element containing a CareConnect-Composition-1 profile | Requirements describing how the Bundle resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-105 | All | General | Profile: CareConnect-Composition-1 | The payload MUST contain a FHIR CareConnect-Composition-1 resource, with the custodian element being populated with a reference to a CareConnect-Organization-1, containing information pertaining to the sending organisation | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-106 | All | General | Profile: CareConnect-Composition-1 | The payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with a reference to a CareConnect-Patient-1 within the subject element | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-107 | All | General | Profile: CareConnect-Composition-1 | The payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with a reference to the sending organisation using the CareConnect-Organization-1 within the author element | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-108 | All | General | Profile: CareConnect-Composition-1 | All FHIR profiles within the payload MUST be populated with resource metadata, using the Meta resource Note: Guidance around how to populate the Meta element for this capability has yet to be defined and our reference example only populates the profile element. | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-109 | All | General | Profile: CareConnect-Composition-1 | The payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with a section element for each attachment | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-110 | All | General | Profile: CareConnect-Composition-1 | Related to GPCM-SD-109, the payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with a section.entry with a reference to an ITK-Attachment-BiN/Ary-1 resource for each attachment | Requirements describing how the Composition resource is populated | GPCM-SD-TST-01 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-111 | All | General | Command 'pagelink' could not render: Page not found. |
The payload MUST contain a FHIR ITK-Attachment-BiN/Ary-1 resource, populated with a base64 encoded attachment in the content element | Requirements describing how biN/Ary documents are included in the payload | GPCM-SD-TST-13 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-123 | All | General | How to handle updates to documents | In the event of a replacement document being sent, the payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with the UUID of the previous message in the relatesTo.identifier element | Requirements describing how the Composition resource is populated | GPCM-SD-TST-08 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-128 | All | General | How to handle updates to documents | The receiver of the new document SHOULD mark the origiN/Al and any replacement documents prior to the new document, as null and void and report a error to the sender using the ITK Response message and appropriate code see ITK3 response codesfor further information | Requirements describing how the Composition resource is populated | GPCM-SD-TST-08 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-129 | All | General | How to handle updates to documents | Replacement documents MAY be done more than once and the new document always refers to the previous document, multiple replacements SHOULD be avoided due to complexity of maintaining the audit trail | Requirements describing how the Composition resource is populated | GPCM-SD-TST-08 | Screenshot(s) of the origiN/Ating patient activity and the resulting message and message response along with any appropriate commentary as to how the data matches between the screenshot and the messages / PDF or is hard coded. |
| GPCM-SD-115 | All | General | Profile: CareConnect-Composition-1 | The payload MUST contain a FHIR CareConnect-Composition-1 resource, populated with SNOMED code: Current approved codes: 371531000 - Report of clinical encounter (record artifact), 149701000000109 -Remote health correspondence (record artifact) | N/A | GPCM-SD-TST-01 | N/A |
| GPCM-SD-083 | Consultation Summary | General | Typical process map | Do NOT send the document to yourself if the patient registration is of type Regular (GMS/PMS) | N/A | GPCM-SD-TST-06 | N/A |
| GPCM-SD-084 | Consultation Summary | General | N/A | A PDS lookup of the patient MUST be performed to determine the ODS code of the registered practice of the patient | N/A | N/A | N/A |
| GPCM-SD-086 | Consultation Summary | General | N/A | The provider system MUST include all data entered by the clinician at the sender practice into the PDF Document in ssensible format and under appropriate clinical headings. This includes all free text, clinical/SNOMED CT codes, dm+d codes and any other data entered relating to the activity. | N/A | GPCM-SD-TST-01 | N/A |
| GPCM-SD-087 | Consultation Summary | General | N/A | All data MUST be displayed in a format that matches how the consultation is displayed on screen or when printed | N/A | GPCM-SD-TST-01 | N/A |
| GPCM-SD-088 | Consultation Summary | General | The provider system MUST include in the message all attachments relating to the activity | N/A | GPCM-SD-TST-01 | N/A | |
| GPCM-SD-090 | Consultation Summary | General | Generic example | The types of data that is expected to be common across all use cases (and should be contained within the PDF) are: document titleversion (if supported)page number x of ycitizen / patient informationsender informationthe intended recipient of the PDFdate and time of the activity / event logical headings representing the information being presented | N/A | GPCM-SD-TST-01 | N/A |
| GPCM-SD-091 | Consultation Summary | General | How to configure MESH | The version number MUST be displayed in the PDF and within the Subject of the MESH .CTL file | N/A | GPCM-SD-TST-01 | N/A |
| GPCM-SD-094 | Consultation Summary | General | N/A | Where a consultation report is not successfully received/maN/Aged by the message receiver, the sender system MUST inform an appropriate person/team | Requirements describing error handling of receiver errors | GPCM-SD-TST-04 | N/A |
| GPCM-SD-095 | Consultation Summary | General | N/A | Where either the infrastructure or business acknowledgements, or both, are not received for a consultation report, the sender system MUST inform an appropriate person/team | Requirements describing error handling of receiver errors | GPCM-SD-TST-05 | N/A |
| GPCM-SD-096 | Consultation Summary | General | N/A | The message sender system MUST send the consultation report within 3 hours after the consultation was created, or last updated | Using Consultation Summary | GPCM-SD-TST-07 | N/A |