Skip to content
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

NIAD-3234: endpoint docs update #1024

Merged
merged 4 commits into from
Dec 6, 2024
Merged

NIAD-3234: endpoint docs update #1024

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6b1f22
endpoint docs update
ole4ryb Dec 5, 2024
26e7214
addressing PR comments
ole4ryb Dec 5, 2024
11daef4
update returned objects in case of an error
ole4ryb Dec 5, 2024
994a0bd
making EhrStatusRequestQuery fields optional
ole4ryb Dec 5, 2024
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
286 changes: 12 additions & 274 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

National Integration Adaptor - [GP2GP Sending Adaptor](https://digital.nhs.uk/developer/api-catalogue/gp2gp/gp2gp-sending-adaptor)

The existing GP2GP solution uses a legacy messaging standard and infrastructure (HL7v3 and Spine TMS). Reliance
on these standards going forward presents a significant barrier to successful GP2GP implementation by new suppliers,
and perpetuation of these standards in the long term presents a risk to the continued operation of GP2GP across all
The existing GP2GP solution uses a legacy messaging standard and infrastructure (HL7v3 and Spine TMS). Reliance
on these standards going forward presents a significant barrier to successful GP2GP implementation by new suppliers,
and perpetuation of these standards in the long term presents a risk to the continued operation of GP2GP across all
suppliers.

A hybrid solution approach has been selected as the best option for GP2GP adoption by NMEs and transition by existing
A hybrid solution approach has been selected as the best option for GP2GP adoption by NMEs and transition by existing
incumbent suppliers.

The "National Integration Adaptor - GP2GP" implements a GP2GP 2.2b producer using the supplier's existing GP Connect
Provider implementation to extract the Electronic Health Record. Suppliers that have not already implemented a
The "National Integration Adaptor - GP2GP" implements a GP2GP 2.2b producer using the supplier's existing GP Connect
Provider implementation to extract the Electronic Health Record. Suppliers that have not already implemented a
GP2GP 2.2b producer, or those wishing to decommission their existing producer, may deploy the GP2GP adaptor in its place.

## Table of contents
Expand All @@ -21,276 +21,14 @@ GP2GP 2.2b producer, or those wishing to decommission their existing producer, m
1. [Guidance on integrating with the adaptors APIs](#how-to-query-the-ehr-status-api)
1. [Documentation on how this adaptor maps GPConnect concepts to GP2GP concepts](https://github.com/NHSDigital/patient-switching-adaptors-mapping-documentation)

## How to query the EHR Status API
## How to query the EHR Status API and the Requests endpoint

An API is provided to query the status of any transfer to an incumbent.

Requests can be made to the following endpoint using the *Conversation ID (SSP-TraceID)* of the transfer:

```http request
{location of gp2gp service}/ehr-status/{conversationId} [GET]
```

The response will contain the following fields:

### EhrStatus

| Field name | Description | Data type | Possible values | nullable |
|---------------------|-----------------------------------------------------------------------------------------------------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------|----------|
| originalRequestDate | The date and time of the original request | ISO-8601 | | False |
| migrationStatus | The current state of the transfer, a status of COMPLETE_WITH_ISSUES is given if placeholder documents were sent | string / enum | COMPLETE <br/><br/>COMPLETE_WITH_ISSUES <br/><br/> FAILED_NME <br/><br/> FAILED_INCUMBENT <br/><br/> IN_PROGRESS | False |
| attachmentStatus | An array of statuses for each document sent during the transfer | Array of **AttachmentStatus** (See below) | | False |
| migrationLog | An array containing details of acknowledgments received during the transfer | Array of **ReceivedAcknowledgement** (See below) | | False |

<br/>

### Subtypes

#### AttachmentStatus

| Field name | Description | Data type | Possible values | Nullable |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|-----------------------------------------------------|----------|
| identifier | An array of identifiers taken from the `identifier` element of the GP Connect `DocumentReference` | Array of **Identifier** (see below) | | False |
| fileStatus | The status of the document sent to the winning practice (can be used to identify if a placeholder document was sent) | string / enum | PLACEHOLDER <br/><br/>ORIGINAL_FILE <br/><br/>ERROR | False |
| filename | The filename sent to winning practice in the GP2GP message | string | | False |
| originalDescription | The description of the file as given by the `description` element of the GP Connect `DocumentReference` resource.<br/><br/> This is inserted into the GP2GP placeholder document as the original filename and suffix. So should be of the form *filename.suffix*, e.g. *referral.txt* | string | | True |

<br/>

#### Identifier

| Field name | Description | Data type | Nullable |
|------------|---------------------------------------------------------------------------|-----------|----------|
| system | The `system` element of the Gp Connect `DocumentReference.identifier` | string | False |
| value | The `identifier` element of the Gp Connect `DocumentReference.identifier` | string | False |


<br/>

#### ReceivedAcknowledgement

| Field name | Description | Data type | Nullable |
|--------------------|------------------------------------------------------------------------------------------------------------|--------------------------------|----------|
| received | The date and time the acknowledgment was received | ISO-8601 | False |
| conversationClosed | If the acknowledgement ended the transfer, the date and time the conversation was closed can be found here | ISO-8601 | True |
| errors | An array of errors which will be populated in the case of a negative / rejected acknowledgement | Array of **Error** (see below) | True |
| messageRef | the Message ID of the message that has been acknowledged | string | False |

<br/>

#### Error

| Field name | Description | Data type | Nullable |
|------------|----------------------------------------------------|-----------|----------|
| code | The GP2GP response code from the negative response | string | False |
| display | The GP2GP response text from the negative response | string | False |

<details>
<summary>EHR Status example responses</summary>

#### Successful migration, with single positive acknowledgement of EHR Extract (conversation closed and no errors):
```json

{
"attachmentStatus": [],
"migrationLog": [
{
"received": "2023-07-24T09:39:09.377Z",
"conversationClosed": "2023-07-24T09:39:09.377Z",
"errors": null,
"messageRef": "0BEBCA12-8BE4-44B4-BDC0-016A4FE3D107"
}
],
"migrationStatus": "COMPLETE",
"originalRequestDate": "2023-07-24T09:38:50.947Z",
"fromAsid": "918999198738",
"toAsid": "200000000359"
}
```

#### Failed by requester, with single negative acknowledgement of EHR Extract (conversation closed and error):

```json

{
"attachmentStatus": [],
"migrationLog": [
{
"received": "2023-07-21T16:09:19.594Z",
"conversationClosed": "2023-07-21T16:09:19.594Z",
"errors": [
{
"code": "11",
"display": "Failed to successfully integrate EHR Extract."
}
],
"messageRef": "C5271147-3D89-4EF6-A719-01AEB3AD00A1"
}
],
"migrationStatus": "FAILED_INCUMBENT",
"originalRequestDate": "2023-07-21T16:09:12.695Z",
"fromAsid": "918999198738",
"toAsid": "200000000359"
}
```


#### Failed by requester, with multiple positive acknowledgements for COPC messages (without conversation closed) and one negative acknowledgement for EHR Extract (conversation closed and error):

```json

{
"attachmentStatus": [
{
"identifier": [
{
"system": "https://EMISWeb/A82038",
"value": "ad174c84-51d1-4744-89e3-7918a31248d1"
}
],
"fileStatus": "ORIGINAL_FILE",
"fileName": "54E94A29-B0CC-4CD6-86B0-B21C9C0CA894.doc",
"originalDescription": "Referral for further care (22-Dec-2020)"
},
{
"identifier": [
{
"system": "https://EMISWeb/A82038",
"value": "D7AF52BA-79BA-4AF8-9010-F0C2DF916CEC"
}
],
"fileStatus": "ORIGINAL_FILE",
"fileName": "629BF3F7-C71F-49D7-8FCD-AEE16C11AFBD.doc",
"originalDescription": "Referral for further care (22-Dec-2020)"
},
{
"identifier": [
{
"system": "https://EMISWeb/A82038",
"value": "D7AF52BA-79BA-4AF8-9010-F0C2DF916CEC"
}
],
"fileStatus": "ORIGINAL_FILE",
"fileName": "2F73A243-0F94-4683-B3F9-727CE7780815.doc",
"originalDescription": "Referral for further care (22-Dec-2020)"
}
],
"migrationLog": [
{
"received": "2023-07-24T10:42:18.591Z",
"conversationClosed": null,
"errors": null,
"messageRef": "ED2FB0DD-52AE-4EBC-B596-3BCA9CF5B272"
},
{
"received": "2023-07-24T10:42:19.176Z",
"conversationClosed": null,
"errors": null,
"messageRef": "5068BAE1-7228-4E59-B3AD-92FA5CBDE4AC"
},
{
"received": "2023-07-24T10:42:19.467Z",
"conversationClosed": null,
"errors": null,
"messageRef": "A9E37B68-07F4-43A5-889E-645D6681CE68"
},
{
"received": "2023-07-24T10:42:22.611Z",
"conversationClosed": "2023-07-24T10:42:22.611Z",
"errors": [
{
"code": "99",
"display": "Unexpected condition."
}
],
"messageRef": "E600D1D4-D5BE-4D0D-8080-F7F6188B0548"
}
],
"migrationStatus": "FAILED_INCUMBENT",
"originalRequestDate": "2023-07-24T10:42:05.757Z",
"fromAsid": "918999198738",
"toAsid": "200000000359"
}
```
#### Failed by adaptor, due to a PATIENT_NOT_FOUND error from the GP Connect provider's migrate structured endpoint
adrianclay marked this conversation as resolved.
Show resolved Hide resolved
```json

{
"attachmentStatus": [],
"migrationLog": [],
"migrationStatus": "FAILED_NME",
"originalRequestDate": "2023-07-26T15:36:22.284Z",
"fromAsid": "918999198738",
"toAsid": "200000000359"
}
```
</details>

## How to query the Requests endpoint

An API is provided to query the status of all transfers to an incumbent.
Any "in-progress" transfers are excluded from this list, but become available once they either succeed or fail.
adrianclay marked this conversation as resolved.
Show resolved Hide resolved

Requests can be made to the following endpoint, where each attribute within the JSON POST body is an optional filter criteria.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related to my comments below about required, this comment reaffirms my understanding which is that the filtering is optional.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I see, make sense, I will look into it and adjust it

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think as object it is required but EhrStatusRequestQuery object has fields which are not mandatory and can be empty.


```http request
POST /requests
Content-Type: application/json

{
"fromDateTime": "2020-10-31T01:30:00.000Z",
"toDateTime": "2030-10-31T01:30:00.000Z",
"fromAsid": "",
"toAsid": "",
"fromOdsCode": "",
"toOdsCode": ""
}
```

The response will contain a JSON array of the following:

### EhrStatusRequest
| Field name | Description | Data type | Possible values | nullable |
| ------------------------ | --------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------- | -------- |
| initialRequestTimestamp | The date and time of the original request. | ISO-8601 | | False |
| actionCompletedTimestamp | The date and time of when the transfer completed. | ISO-8601 | | False |
| nhsNumber | | string | | False |
| conversationId | | string | | False |
| fromAsid | | string | | False |
| toAsid | | string | | False |
| fromOdsCode | | string | | False |
| toOdsCode | | string | | False |
| migrationStatus | The current state of the transfer, a status of COMPLETE_WITH_ISSUES is given if placeholder documents were sent | string / enum | COMPLETE <br/> COMPLETE_WITH_ISSUES <br/> FAILED_NME <br/> FAILED_INCUMBENT | False |


#### Example EhrStatusRequest response

```json
[
{
"initialRequestTimestamp":"2023-09-20T11:47:58.966Z",
"actionCompletedTimestamp":"2023-09-20T11:54:19.552Z",
"nhsNumber":"9729734925",
"conversationId":"59B118DB-70C3-4883-8A60-5E725981F003",
"migrationStatus":"COMPLETE",
"fromAsid":"858000001001",
"toAsid":"200000001908",
"fromOdsCode":"C88046",
"toOdsCode":"B84012"
},
{
"initialRequestTimestamp":"2023-09-20T12:18:10.364Z",
"actionCompletedTimestamp":"2023-09-20T12:18:13.923Z",
"nhsNumber":"9729735336",
"conversationId":"C2A59970-57AF-11EE-AFE6-CD607DC58E3B",
"migrationStatus":"FAILED_INCUMBENT",
"fromAsid":"200000000169",
"toAsid":"200000001908",
"fromOdsCode":"P84009",
"toOdsCode":"B84012"
}
]
```
The API has been documented using the OpenAPI Specification (version 3.0.1). The documentation includes detailed descriptions of endpoints,
parameters, and data models, as well as examples of requests and responses to help developers integrate and use the API effectively
[Ehr Extract OpenAPI Documentation](gp2gp_adaptor_response_docs.yaml)

## Diagrams

Expand All @@ -305,9 +43,9 @@ If you are looking to make changes to the adaptor you should first read the [gui

## Disclaimer

All Patient data within this repository is synthetic
All Patient data within this repository is synthetic

## Licensing
This code is dual licensed under the MIT license and the OGL (Open Government License). Any new work added to this repository must conform to the conditions of these licenses. In particular this means that this project may not depend on GPL-licensed or AGPL-licensed libraries, as these would violate the terms of those libraries' licenses.

The contents of this repository are protected by Crown Copyright (C).
The contents of this repository are protected by Crown Copyright (C).
Loading
Loading