From e4fa7fb40169f196ed10d0da0f5dda91253bfc24 Mon Sep 17 00:00:00 2001 From: chiaramapellimt Date: Wed, 1 Apr 2026 09:21:51 +0100 Subject: [PATCH] NIAD-3440: Updating documentation links --- INBOUND.md | 4 ++-- README.md | 6 +++--- specification/nhais-adaptor.yaml | 10 +++++----- specification/out/index.html | 8 ++++---- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/INBOUND.md b/INBOUND.md index 0b20aa8e..b1a55845 100644 --- a/INBOUND.md +++ b/INBOUND.md @@ -29,7 +29,7 @@ other transactions. See "Transaction Matching" section below for more details. | fp69_flag_removal | FHIR | FP69 Flag Removal | amendment | JSONPatch | Amendment -Some transaction types are [obsolete](https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation) and +Some transaction types are [obsolete](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) and not supported by the adaptor: * MRF and MRS (Medical Records) transactions @@ -89,7 +89,7 @@ GP Links Specification Chapter 3.16.3 lists data fields and their requirements f | Transaction Type | N/A | N/A | N/A | N/A | See "TransactionType" message header | GP Trading Partner Code | Parameters | gpTradingPartnerCode | valueString | | | | GP Code | Patient | /generalPractitioner/0/identifier/value | | | "system": "https://fhir.hl7.org.uk/Id/gmc-number" | -| Sending HA Cipher | Patient | /managingOrganization/identifier/value | | | "system": "https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation" | +| Sending HA Cipher | Patient | /managingOrganization/identifier/value | | | "system": "https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation" | | Transaction Date and Time | N/A | N/A | N/A | N/A | Managed by the adaptor | Transaction Number | N/A | N/A | N/A | N/A | Managed by the adaptor and abstracted by the OperationId message header | NHS Number | Patient | /identifier/0/value | | | "system": "https://fhir.nhs.uk/Id/nhs-number" | diff --git a/README.md b/README.md index 02b7f92d..aade3530 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ specification" except where it directly involves EDIFACT. The specification cont the GP System itself which are out of scope for the adaptor. The patient registration and demographics portion of the former NHS NHAIS system was called -[HA/GP Links](https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation). PCRM may support some +[HA/GP Links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation). PCRM may support some features in addition to GP Links, but these are out of scope for the GP Links Adaptor API. HA/GP Links messaging comprises several types of "transactions" used to update and reconcile patient lists and @@ -127,11 +127,11 @@ system concern. ## Adaptor Architecture -[NHS Digital Developer Hub - NHAIS GP Links adaptor](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/nhais-gp-links-adaptor) +[NHS Digital Developer Hub - NHAIS GP Links adaptor](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) ## Resources -**[Guide to NHAIS/GP links documentation](https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation)** +**[Guide to NHAIS/GP links documentation](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation)** The "Guide to NHAIS/GP links documentation" describes how to use the "NHAIS developer document library" (see below) and provides updates and clarifications to the original documentation. diff --git a/specification/nhais-adaptor.yaml b/specification/nhais-adaptor.yaml index e6a3c443..c04538bc 100644 --- a/specification/nhais-adaptor.yaml +++ b/specification/nhais-adaptor.yaml @@ -25,7 +25,7 @@ info: this adaptor for ANY transaction type. ## Technology - This API is [RESTful](https://digital.nhs.uk/developer/developer-reference/introduction-to-apis#basic-rest) and expects and responds with JSON data formats. + This API is [RESTful](https://digital.nhs.uk/developer/getting-started#learn-about-our-apis) and expects and responds with JSON data formats. It also conforms to the [FHIR](https://digital.nhs.uk/developer/developer-reference/introduction-to-apis#fhir) global standard for health care data exchange. Specifically, it is aligned with [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), which is built on FHIR Release 4. @@ -161,7 +161,7 @@ paths: Refer to GP Links Specification Chapter 3 for the complete requirements for deductions. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. - https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation + [Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) | GP Links Data Item | Deduction | |-------------------------|-----------| @@ -251,7 +251,7 @@ paths: Refer to GP Links Specification Chapter 3 for the complete requirements for removals. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. - https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation + [Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) | GP Links Data Item | Removal | |-------------------------|----------| @@ -338,7 +338,7 @@ paths: Refer to GP Links Specification Chapter 3 for the complete requirements for manually-entered acceptances. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. - https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation + [Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) The following fields are OBSOLETE and not supported by the adaptor: @@ -513,7 +513,7 @@ paths: Refer to GP Links Specification Chapter 3.5 for the complete requirements for manually-entered amendments. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. - https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation + [Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation) Three fields are obsolete and not supported by the adaptor: diff --git a/specification/out/index.html b/specification/out/index.html index b2b5de94..17f465ac 100644 --- a/specification/out/index.html +++ b/specification/out/index.html @@ -1150,7 +1150,7 @@

acceptance

Refer to GP Links Specification Chapter 3 for the complete requirements for manually-entered acceptances. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. -https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation +https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation The following fields are OBSOLETE and not supported by the adaptor: @@ -1840,7 +1840,7 @@

amendment

Refer to GP Links Specification Chapter 3.5 for the complete requirements for manually-entered amendments. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. -https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation +https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation Three fields are obsolete and not supported by the adaptor: @@ -2547,7 +2547,7 @@

deduction

Refer to GP Links Specification Chapter 3 for the complete requirements for deductions. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. -https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation +https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation | GP Links Data Item | Deduction | |-------------------------|-----------| @@ -3154,7 +3154,7 @@

removal

Refer to GP Links Specification Chapter 3 for the complete requirements for removals. The values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001. -https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation +https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation | GP Links Data Item | Removal | |-------------------------|----------|