Skip to content

Documentation update #1471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ORybak5 merged 4 commits into from
May 11, 2026
Merged

Documentation update #1471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d9a2c1
Documentation update
ORybak5 May 11, 2026
30751a0
Merge branch 'main' into docs-update
ORybak5 May 11, 2026
6ab29b9
removal unnecessary ISO spec reference
ORybak5 May 11, 2026
8c8d541
Merge branch 'docs-update' of https://github.com/NHSDigital/integrati…
ORybak5 May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions OPERATING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
57 changes: 42 additions & 15 deletions documentation/database/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -74,13 +79,13 @@
| messageId | String | UUID V4 |
| taskId | String | UUID V4 |
| typeCode | String | AA, AE |
| updatedAt | Date | N/A |
| updatedAt | String | 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 |
Expand All @@ -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 (format timestamp) |
| taskId | String | UUID V4 |

## Errors
Expand All @@ -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")
Loading