From 7d9a2c15b7a7d145f4b3dbb754e0d3c172684eb6 Mon Sep 17 00:00:00 2001 From: ORybak5 <12736698+ORybak5@users.noreply.github.com> Date: Mon, 11 May 2026 10:36:29 +0100 Subject: [PATCH 1/2] Documentation update --- OPERATING.md | 10 +++--- documentation/database/database.md | 57 ++++++++++++++++++++++-------- 2 files changed, 47 insertions(+), 20 deletions(-) diff --git a/OPERATING.md b/OPERATING.md index 2c0661af8c..04aef91d61 100644 --- a/OPERATING.md +++ b/OPERATING.md @@ -168,14 +168,14 @@ TODO: Sequence diagram "user journey" of Spine messages, tasks, and GPCC request Adaptor document tasks are defined and documented in Java source code: -* [TaskDefinition.java](https://github.com/nhsconnect/integration-adaptor-gp2gp/tree/main/service/src/main/java/uk/nhs/adaptors/gp2gp/common/task/TaskDefinition.java) -* [DocumentTaskDefinition.java](https://github.com/nhsconnect/integration-adaptor-gp2gp/tree/main/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/DocumentTaskDefinition.java) +* [TaskDefinition.java](service/src/main/java/uk/nhs/adaptors/gp2gp/common/task/TaskDefinition.java) +* [DocumentTaskDefinition.java](service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/DocumentTaskDefinition.java) * [Get GPC Document Task Example](/documentation/examples/Task_queue_payloads/GetGpcDocumentTaskDefinition.md) -* [SendEhrExtractCoreTaskDefinition.java](https://github.com/nhsconnect/integration-adaptor-gp2gp/tree/main/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/SendEhrExtractCoreTaskDefinition.java) +* [SendEhrExtractCoreTaskDefinition.java](service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/SendEhrExtractCoreTaskDefinition.java) * [Send EHR Extract Core Task Example](/documentation/examples/Task_queue_payloads/SendEhrExtractCoreTaskDefinition.md) -* [GetGpcStructuredTaskDefinition.java](https://github.com/nhsconnect/integration-adaptor-gp2gp/tree/main/service/src/main/java/uk/nhs/adaptors/gp2gp/gpc/GetGpcStructuredTaskDefinition.java) +* [GetGpcStructuredTaskDefinition.java](service/src/main/java/uk/nhs/adaptors/gp2gp/gpc/GetGpcStructuredTaskDefinition.java) * [Get GPC Structured Record Task Example](/documentation/examples/Task_queue_payloads/GetGpcStructuredTaskDefinition.md) -* [SendAcknowledgementTaskDefinition.java](https://github.com/nhsconnect/integration-adaptor-gp2gp/tree/main/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/SendAcknowledgementTaskDefinition.java) +* [SendAcknowledgementTaskDefinition.java](service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/SendAcknowledgementTaskDefinition.java) * [Send Acknowledgement Task Example](/documentation/examples/Task_queue_payloads/sendAcknowledgementTaskDefinition.md) ## Logging and Tracing diff --git a/documentation/database/database.md b/documentation/database/database.md index 0f2c804f69..8618200cb9 100644 --- a/documentation/database/database.md +++ b/documentation/database/database.md @@ -4,18 +4,23 @@ | Field Name | Datatype | Constraints | | -------------------------- | -------- | ------------------------------------------------------------ | +| id | String | MongoDB ObjectId | | created | Date | N/A | | updatedAt | Date | N/A | -| conversationId | String | UUID V4 | +| conversationId | String | UUID V4, Unique | | ehrRequest | Object | [EHR Request](database.md#ehr-request) | | gpcAccessDocument | Object | [GPC Access Document](database.md#gpc-access-document) | | gpcAccessStructured | Object | [GPC Access Structured](database.md#gpc-access-structured) | | ehrExtractCorePending | Object | [EHR Extract Core Pending](database.md#ehr-extract-core-pending) | -| ehrContrinue | Object | [EHR Continue](database.md#ehr-continue) | +| ehrContinue | Object | [EHR Continue](database.md#ehr-continue) | | ehrExtractCore | Object | [EHR Extract Core](database.md#ehr-extract-core) | | ackPending | Object | [ACK Pending](database.md#ack-pending) | | ackToRequester | Object | [ACK To Requester](database.md#ack-to-requester) | -| ehrReceivedAcknowledgement | Object | [EHR Receieved Acknowledgement](database.md#ehr-received-acknowledgement) | +| ehrReceivedAcknowledgement | Object | [EHR Received Acknowledgement](database.md#ehr-received-acknowledgement) | +| error | Object | [Error](database.md#error) | +| messageTimestamp | Date | N/A | +| ehrExtractMessageId | String | UUID V4 | +| ackHistory | Object | [ACK History](database.md#ack-history) | ## EHR Request @@ -74,13 +79,13 @@ | messageId | String | UUID V4 | | taskId | String | UUID V4 | | typeCode | String | AA, AE | -| updatedAt | Date | N/A | +| updatedAt | String | ISO-8601 format timestamp | ## ACK To Requester | Field Name | Datatype | Constraints | | ---------- | -------- | ----------- | -| details | String | N/A | +| detail | String | N/A | | messageId | String | UUID V4 | | reasonCode | String | N/A | | taskId | String | UUID V4 | @@ -98,22 +103,29 @@ ## GPC Document -| Field Name | Datatype | Constraints | -| ----------------- | -------- | --------------------------------------- | -| documentId | String | UUID V4 | -| accessDocumentUrl | String | URL | -| accessedDate | Date | N/A | -| taskId | String | UUID V4 | -| messageId | String | UUID V4 | -| objectName | String | N/A | -| sentToMhs | Object | [EHR Continue](database.md#sent-to-mhs) | +| Field Name | Datatype | Constraints | +| -------------------- | -------------- | --------------------------------------- | +| documentId | String | UUID V4 | +| accessDocumentUrl | String | URL | +| accessedAt | Date | N/A | +| contentLength | Integer | N/A | +| fileName | String | N/A | +| contentType | String | N/A | +| objectName | String | N/A | +| taskId | String | UUID V4 | +| messageId | String | UUID V4 | +| isSkeleton | Boolean | N/A | +| identifier | Object (Array) | List of Identifiers | +| originalDescription | String | N/A | +| gpConnectErrorMessage| String | N/A (Error message from GP Connect) | +| sentToMhs | Object | [Sent To MHS](database.md#sent-to-mhs) | ## Sent To MHS | Field Name | Datatype | Constraints | | ---------- | -------------- | ----------- | | messageId | String (Array) | UUID V4's | -| sentAt | Date | N/A | +| sentAt | String | N/A (ISO-8601 format timestamp) | | taskId | String | UUID V4 | ## Errors @@ -123,6 +135,21 @@ | code | String | N/A | | display | String | N/A | +## Error + +| Field Name | Datatype | Constraints | +|------------|----------|-------------| +| occurredAt | Date | N/A | +| code | String | N/A | +| message | String | N/A | +| taskType | String | N/A | + +## ACK History + +| Field Name | Datatype | Constraints | +|------------|----------------|--------------------------------------------------------------| +| acks | Object (Array) | [EHR Received Acknowledgement](database.md#ehr-received-acknowledgement) | + ## Database entities ![EHR Extract Status Structure](EhrExtractStatus.drawio.png "EHR Extract Status Structure") \ No newline at end of file From 6ab29b91d82f5089f8199312ffa8288bc543971e Mon Sep 17 00:00:00 2001 From: ORybak5 <12736698+ORybak5@users.noreply.github.com> Date: Mon, 11 May 2026 10:50:27 +0100 Subject: [PATCH 2/2] removal unnecessary ISO spec reference --- documentation/database/database.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/database/database.md b/documentation/database/database.md index 8618200cb9..4dcc2e938d 100644 --- a/documentation/database/database.md +++ b/documentation/database/database.md @@ -79,7 +79,7 @@ | messageId | String | UUID V4 | | taskId | String | UUID V4 | | typeCode | String | AA, AE | -| updatedAt | String | ISO-8601 format timestamp | +| updatedAt | String | format timestamp | ## ACK To Requester @@ -125,7 +125,7 @@ | Field Name | Datatype | Constraints | | ---------- | -------------- | ----------- | | messageId | String (Array) | UUID V4's | -| sentAt | String | N/A (ISO-8601 format timestamp) | +| sentAt | String | N/A (format timestamp) | | taskId | String | UUID V4 | ## Errors