Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Payload requirements

Details of the FHIR® resources which make up the payload for the Consultation Summary Report use case.

Please refer to Send Document - Payload structure for a definition of the payload structure to be used to fulfil the Consultation Summary Report use case.

The following sections describe the resources which form the payload. These are the resources that 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.

Composition resource

GPCM-SD-CS-017 a Composition resource profiled to CareConnect-Composition-1 resource MUST be present in the payload

The following requirements describe how the Composition resource is populated:

GPCM-SD-CS-018 Composition.status MUST contain fixed value final
GPCM-SD-CS-019 Composition.type MUST contain the SNOMED code 371531000 (Report of clinical encounter)
GPCM-SD-CS-020 Composition.date MUST contain the date/time the message was created
GPCM-SD-CS-021 Composition.confidentiality MUST contain the fixed value N (Normal), or R (Restricted) if the consultation is classed as confidential
GPCM-SD-CS-022 Composition.title MUST contain the fixed value Consultation report
GPCM-SD-CS-023 Composition.text MUST contain a summary of request in the following format:
Consultation report for {Patient Name}, NHS Number {NHS Number}, seen at {Practice Name}*, ODS Code {ODS Code}*, Version {Version Number}
* these items MUST NOT be displayed if the consultation has been flagged as restricted/confidential
GPCM-SD-CS-024 Composition.subject MUST contain a reference to Patient resource profiled to CareConnect-Patient-1
GPCM-SD-CS-025 Composition.author MUST contain a reference to a Practitioner resource profiled to CareConnect-Practitioner-1
GPCM-SD-CS-026 Composition.custodian MUST contain a reference to the sender Organization resource profiled to CareConnect-Organization-1
GPCM-SD-CS-027 Composition.relatesTo MUST contain the UUID of the previous message if a replacement document is being sent
GPCM-SD-CS-028 Composition.section.entry MUST reference a binary document which provides a report of the consultation in PDF format


Additional input elements

Message senders MAY include additional binary documents in the payload as each expressed as an additional instance of the composition.section as described in Send Document - payload structure.

GPCM-SD-CS-029 where binary documents are included in the payload in addition to the Consultation Report, the message receiver MUST process these according ensuring all attachments remain in the context of the encounter information delivered to downstream systems
GPCM-SD-CS-030 when displaying the Consultation Report in the practice workflow/task list, the message receiver MUST display the Subject contained in the MESH .CTL file:
Consultation report for {Patient Name}, NHS Number {NHS Number}, seen at {Practice Name}*, ODS Code {ODS Code}*
* these items MUST NOT be displayed if the consultation has been flagged as confidential
GPCM-SD-CS-031 the message receiver MUST make any attachments included with the Consultation Report available to the end user

Organization resources

GPCM-SD-CS-032 as described in Send Document - Payload structure, the payload MUST contain an organization resource describing the sender organisation (the originating organisation)

The table below outlines how these resources are populated:

GPCM-SD-CS-033 the odsOrganisationCode slice of the identifier element MUST contain the ODS code
GPCM-SD-CS-034 the name element MUST contain the name of the organisation
GPCM-SD-CS-035 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-CS-036 the SDS User ID of the practitioner MUST be present in the sdsUserID slice of the identifier element
GPCM-SD-CS-037 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-CS-038 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-CS-039 the NHS Number of the patient MUST be specified in the nhsNumber slice of the identifier element
GPCM-SD-CS-040 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-CS-041 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-CS-042 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

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