Skip to content

NIAD-3442: Update documentation links #313

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
chiaramapellimt merged 4 commits into from
Mar 31, 2026
Merged

NIAD-3442: Update documentation links #313

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cd1fdb
Initial update from Readme
chiaramapellimt Mar 26, 2026
2966420
Initial update from Readme
chiaramapellimt Mar 26, 2026
8ac800e
Initial update from Readme
chiaramapellimt Mar 27, 2026
ac4cc5d
Initial update from Readme
chiaramapellimt Mar 27, 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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@

The GP Connect Consumer Adaptor allows a GP Connect Consumer to connect to a GP Connect Producer over Spine.
The adaptor proxies GP Connect API requests to the correct GP Connect producer. It performs the
[Spine integration required to consume GP Connect capabilities](https://developer.nhs.uk/apis/gpconnect-1-6-0/integration_illustrated.html#spine-integration-required-to-consume-gp-connect-capabilities).
[Spine integration required to consume GP Connect capabilities](https://nhsconnect.github.io/FHIR-SpineCore/integration_example_gpconnect.html#spine-integration-required-to-consume-gp-connect-capabilities).

## Adaptor API

The GP Connect Consumer Adaptor adheres to the GP Connect API specifications.

We only support the two endpoints required for the GP2GP use case:

* Capability: [Migrate Structured Record](https://gpc-structured-1-5-0.netlify.app/accessrecord_structured.html)
* Endpoint: [Migrate a patient's structured record](https://developer.nhs.uk/apis/gpconnect-1-6-0/accessrecord_structured_development_migrate_patient_record.html)
* Capability: [Access Document](https://gpc-structured-1-5-0.netlify.app/access_documents.html)
* Endpoint: [Retrieve a document](https://gpc-structured-1-5-0.netlify.app/access_documents_development_retrieve_patient_documents.html)
* Capability: [Migrate Structured Record](https://gpc-structured-1-6-0.netlify.app/accessrecord_structured.html)
* Endpoint: [Migrate a patient's structured record](https://gpc-structured-1-6-0.netlify.app/accessrecord_structured_development_migrate_patient_record.html)
* Capability: [Access Document](https://gpc-structured-1-6-0.netlify.app/access_documents.html)
* Endpoint: [Retrieve a document](https://gpc-structured-1-6-0.netlify.app/access_documents_development_retrieve_patient_documents.html)

### Service Root URL

Expand Down Expand Up @@ -78,7 +78,7 @@ to use the adaptor in the integration and production environments.
| ------------------------|---------|-------------
| GPC_CONSUMER_SDS_URL | | [URL of the SDS FHIR API]
| GPC_CONSUMER_SDS_APIKEY | | Secret key used to authenticate with the API
| GPC_SUPPLIER_ODS_CODE | | Supplier ODS code [see GP Connect Docs](https://developer.nhs.uk/apis/gpconnect-1-6-0/integration_spine_directory_service.html#looking-up-a-consumers-own-asid)
| GPC_SUPPLIER_ODS_CODE | | Supplier ODS code [see GP Connect Docs](https://digital.nhs.uk/services/gp-connect/develop-gp-connect-services/integrate-with-spine/spine-directory-service#looking-up-a-consumer-s-own-asid)

[URL of the SDS FHIR API]: https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-fhir#overview--environments-and-testing

Expand Down Expand Up @@ -106,7 +106,7 @@ adequate infrastructure and connections to external APIs.

We provide several example configurations:

* `vars.public.sh` runs the adaptor with the [GP Connect public demonstrator](Docker image - https://developer.nhs.uk/apis/gpconnect-1-6-0/overview_release_notes_1_6_0.html) and the [SDS FHIR API sandbox](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing)
* `vars.public.sh` runs the adaptor with the [GP Connect public demonstrator](https://github.com/nhsconnect/gpconnect-demonstrator) and the [SDS FHIR API sandbox](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing)

Edit `vars.local.sh` / `vars.public.sh` to add any missing values e.g. Spine certificates.

Expand Down Expand Up @@ -172,7 +172,7 @@ tests use the same variables as the application.

The stateless GP Connect Consumer Adaptor does not use a database or a message queue.

The adaptor requires an [HSCN](https://digital.nhs.uk/services/health-and-social-care-network) network connection to use the [Spine Secure Proxy](https://developer.nhs.uk/apis/spine-core-1-0/ssp_overview.html).
The adaptor requires an [HSCN](https://digital.nhs.uk/services/health-and-social-care-network) network connection to use the [Spine Secure Proxy](https://digital.nhs.uk/services/gp-connect/develop-gp-connect-services/integrate-with-spine/spine-secure-proxy).

The adaptor can access the [SDS FHIR API](https://digital.nhs.uk/developer/api-catalogue/spine-directory-service-fhir) over either the HSCN network or the public internet.

Expand Down
Loading