where the message contains patient information, for example as a result of a healthcare event, the CareConnect-CompositionComposition.subject element MUST contain a patient resource which conforms to the CareConnect-Patient-1 profile
the CareConnect-CompositionComposition.author element MUST contain one or more references to the individual or device that has authored the data in the payload. This includes the following resources:
where the message contains encounter information, a Composition.encounter referencing a CareConnect-Encounter-1SHOULD be present
where the message contains observation information, a Composition.section.entry referencing a CareConnect-List-1SHOULD be present. This resource lists all the observations present in the payload.
observations referenced in the the CareConnect-GPC-List-1SHOULD each populate a Composition.section.entry referencing an Observation resource which conforms to the CareConnect-Observation-1 profile, describing each observation
where a message contains questionnaire information, a Composition.section.entry referencing a CareConnect-Questionnaire-1SHOULD be present. This resource fully describes questionnaire being completed
where a message contains questionnaire response information, a Composition.section.entry referencing a CareConnect-QuestionnaireResponse-1SHOULD be present. This resource describes all the questions asked to the patient and all the responses given
where a message contains a task, a Composition.section.entry referencing a CareConnect-Task-1SHOULD be present
where a message contains patient consent, a Composition.section.entry referencing a CareConnect-Consent-1SHOULD be present
where a message contains a location, a Composition.section.entry referencing a CareConnect-Location-1SHOULD be present
all meta elements MUST be treated as mandatory and populated with the associated resource
all id elements MUST be treated as mandatory, except when the resource is being created (initial creation call)
Including documents in the payload
The following requirements describe how binary documents are included in the payload:
each binary document sent in the payload MUST be included as an instance of the Composition.section element
Each instance of a binary document will be included as follows:
each Composition.section.entryMUST be a FHIR Reference containing a reference to an attachment profiled to ITK-Attachment-Binary-1
all attachments MUST be Base64 encoded
the primary attachment MUST be the first Composition.section.entry in the payload
Note: Please refer to the particular use case in question for detailed requirements on the population of these payload resources. Example FHIR® Messages illustrating how payloads look on-the-wire are available for each use case.
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, as described in the sections above: