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
    "Hospital",
11
    "Hospital",
            
12
    "Mental health",
12
    "Mental health",
            
13
    "Patient",
13
    "Patient",
            
14
    "GP / Primary care",
14
    "GP / Primary care",
            
15
    "Urgent and Emergency Care"
15
    "Urgent and Emergency Care"
            
16
  ],
16
  ],
            
17
  "contact_details": "api.management@nhs.net",
17
  "contact_details": "api.management@nhs.net",
            
18
  "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03",
18
  "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03",
            
19
  "dependencies": "No known dependencies",
19
  "dependencies": "No known dependencies",
            
20
  "description": "Receive notifications about changes to a patient's 
20
  "description": "Receive notifications about changes to a patient's 
            
21
demographic details, including birth, death, change of address and 
21
demographic details, including birth, death, change of address and 
            
22
change of GP.",
22
change of GP.",
            
23
  "documentation_help_text": "",
23
  "documentation_help_text": "",
            
24
  "documentation_link": 
24
  "documentation_link": 
            
25
loper/api-catalogue/personal-demographics-service-notifications-fhir",
25
loper/api-catalogue/personal-demographics-service-notifications-fhir",
            
26
  "endorsements": "Not applicable",
26
  "endorsements": "Not applicable",
            
27
  "groups": [],
27
  "groups": [],
            
28
  "id": "abab71aa-69c2-4416-b5d5-306a91765b32",
28
  "id": "abab71aa-69c2-4416-b5d5-306a91765b32",
            
29
  "isopen": false,
29
  "isopen": false,
            
30
  "license_id": null,
30
  "license_id": null,
            
31
  "license_title": null,
31
  "license_title": null,
            
32
  "maintainer": null,
32
  "maintainer": null,
            
33
  "maintainer_email": null,
33
  "maintainer_email": null,
            
34
  "mandated": "false",
34
  "mandated": "false",
            
35
  "metadata_created": "2021-12-22T13:24:22.310661",
35
  "metadata_created": "2021-12-22T13:24:22.310661",
            
n
36
  "metadata_modified": "2022-04-07T14:47:56.346899",
n
36
  "metadata_modified": "2022-05-04T13:05:05.858122",
            
37
  "name": "personal-demographics-service-notifications-fhir-api",
37
  "name": "personal-demographics-service-notifications-fhir-api",
            
38
  "notes": null,
38
  "notes": null,
            
39
  "num_resources": 0,
39
  "num_resources": 0,
            
40
  "num_tags": 0,
40
  "num_tags": 0,
            
41
  "organization": {
41
  "organization": {
            
42
    "approval_status": "approved",
42
    "approval_status": "approved",
            
43
    "created": "2021-10-20T10:14:34.962258",
43
    "created": "2021-10-20T10:14:34.962258",
            
44
    "description": "",
44
    "description": "",
            
45
    "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
45
    "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
            
46
    "image_url": "",
46
    "image_url": "",
            
47
    "is_organization": true,
47
    "is_organization": true,
            
48
    "name": "nhs-digital",
48
    "name": "nhs-digital",
            
49
    "state": "active",
49
    "state": "active",
            
50
    "title": "NHS Digital",
50
    "title": "NHS Digital",
            
51
    "type": "organization"
51
    "type": "organization"
            
52
  },
52
  },
            
53
  "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
53
  "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615",
            
54
  "private": false,
54
  "private": false,
            
55
  "reference_code": "",
55
  "reference_code": "",
            
56
  "related_standards": "The following APIs also give access to the 
56
  "related_standards": "The following APIs also give access to the 
            
t
57
Personal Demographics Service:\r\n* [Personal Demographics Service - 
t
57
Personal Demographics Service:\n\nPersonal Demographics Service - FHIR 
            
58
FHIR 

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

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

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

            
64
- use this if you want to use functions that are not yet available on 
60
V3 API - use this if you want to use functions that are not yet 
            
65
the FHIR API.\r\n\r\nThe following APIs are also related to this 
61
available on the FHIR API.\nThe following APIs are also related to 
            
66
API:\r\n* [Organisation Data Service - FHIR 
62
this API:\n\nOrganisation Data Service - FHIR API - use this to get 
            
67
l.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3) 
63
full details for the organisations related to the patient, such as 
            
68
- use this to get full details for the organisations related to the 
64
their registered GP or nominated pharmacy.\nOrganisation Data Service 
            
69
patient, such as their registered GP or nominated pharmacy.\r\n* 

            
70
[Organisation Data Service - ORD 

            
71
/digital.nhs.uk/developer/api-catalogue/organisation-data-service-ord) 

            
72
- use this to access a searchable national repository of NHS 
65
- ORD API - use this to access a searchable national repository of NHS 
            
73
Organisation Reference Data using an ORD interface.",
66
Organisation Reference Data using an ORD interface.",
            
74
  "relationships_as_object": [],
67
  "relationships_as_object": [],
            
75
  "relationships_as_subject": [],
68
  "relationships_as_subject": [],
            
76
  "resources": [],
69
  "resources": [],
            
77
  "standard_category": "Technical standards and specifications",
70
  "standard_category": "Technical standards and specifications",
            
78
  "state": "active",
71
  "state": "active",
            
79
  "status": "deprecated",
72
  "status": "deprecated",
            
80
  "tags": [],
73
  "tags": [],
            
81
  "title": "Personal Demographics Service Notifications - FHIR API",
74
  "title": "Personal Demographics Service Notifications - FHIR API",
            
82
  "topic": [
75
  "topic": [
            
83
    "Continuity of care (ToC)",
76
    "Continuity of care (ToC)",
            
84
    "Demographics"
77
    "Demographics"
            
85
  ],
78
  ],
            
86
  "type": "dataset",
79
  "type": "dataset",
            
87
  "url": null,
80
  "url": null,
            
88
  "version": null
81
  "version": null
            
89
}
82
}