Changes

              
    

          
          
        
        

            
f
1
{
f
1
{
            
2
  "assurance": "The NHS Digital API Catalogue uses a development 
2
  "assurance": "The NHS Digital API Catalogue uses a development 
            
3
process based on [GDS agile 
3
process based on [GDS agile 
            
4
delivery](https://www.gov.uk/service-manual/agile-delivery). You can 
4
delivery](https://www.gov.uk/service-manual/agile-delivery). You can 
            
5
find out more about how they develop APIs, technical standards and 
5
find out more about how they develop APIs, technical standards and 
            
6
specifications in their [reference 
6
specifications in their [reference 
            
7
/digital.nhs.uk/developer/guides-and-documentation/reference-guide).",
7
/digital.nhs.uk/developer/guides-and-documentation/reference-guide).",
            
8
  "author": null,
8
  "author": null,
            
9
  "author_email": null,
9
  "author_email": null,
            
10
  "care_setting": [
10
  "care_setting": [
            
11
    "GP / Primary care"
11
    "GP / Primary care"
            
12
  ],
12
  ],
            
13
  "contact_details": "api.management@nhs.net",
13
  "contact_details": "api.management@nhs.net",
            
14
  "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03",
14
  "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03",
            
15
  "dependencies": "No known dependencies",
15
  "dependencies": "No known dependencies",
            
16
  "description": "Manage GP registrations and other patient data in 
16
  "description": "Manage GP registrations and other patient data in 
            
17
NHAIS.",
17
NHAIS.",
            
18
  "documentation_help_text": "",
18
  "documentation_help_text": "",
            
19
  "documentation_link": 
19
  "documentation_link": 
            
20
"https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links",
20
"https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links",
            
21
  "endorsements": "Not applicable",
21
  "endorsements": "Not applicable",
            
22
  "groups": [],
22
  "groups": [],
            
23
  "id": "f5950a95-693b-48c0-aa04-a6330fae2dcc",
23
  "id": "f5950a95-693b-48c0-aa04-a6330fae2dcc",
            
24
  "isopen": false,
24
  "isopen": false,
            
25
  "license_id": null,
25
  "license_id": null,
            
26
  "license_title": null,
26
  "license_title": null,
            
27
  "maintainer": null,
27
  "maintainer": null,
            
28
  "maintainer_email": null,
28
  "maintainer_email": null,
            
29
  "mandated": "false",
29
  "mandated": "false",
            
30
  "metadata_created": "2021-12-22T13:24:13.933176",
30
  "metadata_created": "2021-12-22T13:24:13.933176",
            
n
31
  "metadata_modified": "2022-04-07T14:48:03.359303",
n
31
  "metadata_modified": "2022-05-04T13:04:59.096206",
            
32
  "name": 
32
  "name": 
            
33
al-health-application-and-infrastructure-services-nhais-gp-links-api",
33
al-health-application-and-infrastructure-services-nhais-gp-links-api",
            
34
  "notes": null,
34
  "notes": null,
            
35
  "num_resources": 0,
35
  "num_resources": 0,
            
36
  "num_tags": 0,
36
  "num_tags": 0,
            
37
  "organization": {
37
  "organization": {
            
38
    "approval_status": "approved",
38
    "approval_status": "approved",
            
39
    "created": "2021-10-20T10:14:34.962258",
39
    "created": "2021-10-20T10:14:34.962258",
            
40
    "description": "",
40
    "description": "",
            
41
    "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
41
    "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
            
42
    "image_url": "",
42
    "image_url": "",
            
43
    "is_organization": true,
43
    "is_organization": true,
            
44
    "name": "nhs-digital",
44
    "name": "nhs-digital",
            
45
    "state": "active",
45
    "state": "active",
            
46
    "title": "NHS Digital",
46
    "title": "NHS Digital",
            
47
    "type": "organization"
47
    "type": "organization"
            
48
  },
48
  },
            
49
  "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
49
  "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
            
50
  "private": false,
50
  "private": false,
            
51
  "reference_code": "",
51
  "reference_code": "",
            
n
52
  "related_standards": "This API relates to:\r\n* [GP2GP - HL7 V3 
n
52
  "related_standards": "The following APIs are related to this 
            
53
API](https://digital.nhs.uk/developer/api-catalogue/gp2gp) - use this 
53
one:\n\nGP2GP - HL7 V3 API - use this API to transfer patients' 
            
54
API to transfer patients' electronic health records between old and 
54
electronic health records between old and new practices when they 
            
55
new practices when they change GPs.\r\n* [Personal Demographics 
55
change GPs.\nPersonal Demographics Service - FHIR API - use this new 
            
56
Service - FHIR 

            
57
tal.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) 

            
58
- use this new API to search for patients, retrieve patients by NHS 
56
API to search for patients, retrieve patients by NHS number and update 
            
59
number and update patients\r\n* [Personal Demographics Service - HL7 
57
patients.\nPersonal Demographics Service - HL7 V3 API - use this if 
            
60
V3 

            
61
l.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3) 

            
62
- use this if you want to use functions that are not yet available on 
58
you want to use functions that are not yet available on the FHIR 
            
63
the FHIR API\r\n* [Personal Demographics Service - SMSP 
59
API.\nPersonal Demographics Service - SMSP API - use this if you want 
            
64
s/spine/spine-mini-service-provider-for-personal-demographics-service) 
60
to get PDS data without an authenticated end user (no smartcard 
            
65
- use this if you want to get PDS data without an authenticated end 

            
66
user (no 

            
67
tps://digital.nhs.uk/services/registration-authorities-and-smartcards) 

            
68
required). It is, however, read-only and searches are limited to a 
61
required). It is, however, read-only and searches are limited to a 
            
t
69
single result\r\n* [Messaging Exchange for Social care and Health 
t
62
single result.\nMessaging Exchange for Social care and Health (MESH) - 
            
70
veloper/api-catalogue/message-exchange-for-social-care-and-health-api) 

            
71
- use this component of the Spine to deliver messages and files to 
63
use this component of the Spine to deliver messages and files to 
            
72
registered recipients",
64
registered recipients.",
            
73
  "relationships_as_object": [],
65
  "relationships_as_object": [],
            
74
  "relationships_as_subject": [],
66
  "relationships_as_subject": [],
            
75
  "resources": [],
67
  "resources": [],
            
76
  "standard_category": "Technical standards and specifications",
68
  "standard_category": "Technical standards and specifications",
            
77
  "state": "active",
69
  "state": "active",
            
78
  "status": "active",
70
  "status": "active",
            
79
  "tags": [],
71
  "tags": [],
            
80
  "title": "National Health Application and Infrastructure Services - 
72
  "title": "National Health Application and Infrastructure Services - 
            
81
NHAIS GP Links API",
73
NHAIS GP Links API",
            
82
  "topic": [
74
  "topic": [
            
83
    "Demographics",
75
    "Demographics",
            
84
    "Messaging"
76
    "Messaging"
            
85
  ],
77
  ],
            
86
  "type": "dataset",
78
  "type": "dataset",
            
87
  "url": null,
79
  "url": null,
            
88
  "version": null
80
  "version": null
            
89
}
81
}