f | { | f | { |
| "assurance": "The NHS Digital API Catalogue uses a development | | "assurance": "The NHS Digital API Catalogue uses a development |
| process based on [GDS agile | | process based on [GDS agile |
| delivery](https://www.gov.uk/service-manual/agile-delivery). You can | | delivery](https://www.gov.uk/service-manual/agile-delivery). You can |
| find out more about how they develop APIs, technical standards and | | find out more about how they develop APIs, technical standards and |
| specifications in their [reference | | specifications in their [reference |
| nd-documentation/reference-guide#deprecation-and-retirement-policy).", | | nd-documentation/reference-guide#deprecation-and-retirement-policy).", |
| "author": null, | | "author": null, |
| "author_email": null, | | "author_email": null, |
| "care_setting": [ | | "care_setting": [ |
| "GP / Primary care" | | "GP / Primary care" |
| ], | | ], |
| "contact_details": "api.management@nhs.net", | | "contact_details": "api.management@nhs.net", |
| "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03", | | "creator_user_id": "b437b157-ceb9-446e-bfbc-edc78ff0ca03", |
| "dependencies": "No known dependencies", | | "dependencies": "No known dependencies", |
| "description": "Transfer patients' electronic health records, | | "description": "Transfer patients' electronic health records, |
| securely and quickly, between their old and new practices when they | | securely and quickly, between their old and new practices when they |
| change GPs.", | | change GPs.", |
| "documentation_help_text": "", | | "documentation_help_text": "", |
| "documentation_link": | | "documentation_link": |
| "https://digital.nhs.uk/developer/api-catalogue/gp2gp", | | "https://digital.nhs.uk/developer/api-catalogue/gp2gp", |
| "endorsements": "Not applicable", | | "endorsements": "Not applicable", |
| "groups": [], | | "groups": [], |
| "id": "cef5b6bc-168a-4d2e-8225-571aba527962", | | "id": "cef5b6bc-168a-4d2e-8225-571aba527962", |
| "isopen": false, | | "isopen": false, |
| "license_id": null, | | "license_id": null, |
| "license_title": null, | | "license_title": null, |
| "maintainer": null, | | "maintainer": null, |
| "maintainer_email": null, | | "maintainer_email": null, |
| "mandated": "false", | | "mandated": "false", |
| "metadata_created": "2021-12-22T13:24:09.800547", | | "metadata_created": "2021-12-22T13:24:09.800547", |
n | "metadata_modified": "2022-04-07T14:48:17.604751", | n | "metadata_modified": "2022-05-04T13:04:55.188313", |
| "name": "gp2gp-hl7-v3-api", | | "name": "gp2gp-hl7-v3-api", |
| "notes": null, | | "notes": null, |
| "num_resources": 0, | | "num_resources": 0, |
| "num_tags": 0, | | "num_tags": 0, |
| "organization": { | | "organization": { |
| "approval_status": "approved", | | "approval_status": "approved", |
| "created": "2021-10-20T10:14:34.962258", | | "created": "2021-10-20T10:14:34.962258", |
| "description": "", | | "description": "", |
| "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615", | | "id": "38566f9e-3b00-41ae-a1e9-7fc35b55d615", |
| "image_url": "", | | "image_url": "", |
| "is_organization": true, | | "is_organization": true, |
| "name": "nhs-digital", | | "name": "nhs-digital", |
| "state": "active", | | "state": "active", |
| "title": "NHS Digital", | | "title": "NHS Digital", |
| "type": "organization" | | "type": "organization" |
| }, | | }, |
| "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615", | | "owner_org": "38566f9e-3b00-41ae-a1e9-7fc35b55d615", |
| "private": false, | | "private": false, |
| "reference_code": "", | | "reference_code": "", |
t | "related_standards": "This standards relates to the following | t | "related_standards": "The following APIs are related to this |
| APIs:\r\n* [Personal Demographics Service - FHIR | | one:\n\nPersonal Demographics Service - FHIR API - use this new API to |
| tal.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) | | search for patients, retrieve patients by NHS number and update |
| - use this new API to search for patients, retrieve patients by NHS | | patients.\nPersonal Demographics Service - HL7 V3 API - use this if |
| number and update patients.\r\n* [Personal Demographics Service - HL7 | | |
| V3 | | |
| l.nhs.uk/developer/api-catalogue/personal-demographics-service-hl7-v3) | | |
| - use this if you want to use functions that are not yet available on | | you want to use functions that are not yet available on the FHIR |
| the FHIR API.\r\n* [Personal Demographics Service - SMSP | | API.\nPersonal Demographics Service - SMSP API - use this if you want |
| s/spine/spine-mini-service-provider-for-personal-demographics-service) | | to get PDS data without an authenticated end user (no smartcard |
| - use this if you want to get PDS data without an authenticated end | | required). It is, however, read-only and searches are limited to a |
| user (no smartcard required). It is, however, read-only and searches | | single result.\nSpine Directory Service - LDAP API - use this to |
| are limited to a single result.\r\n* [Spine Directory Service - LDAP | | |
| tps://digital.nhs.uk/services/registration-authorities-and-smartcards) | | |
| - use this to access data in the Spine using Directory Service (SDS), | | access data in the Spine using Directory Service (SDS), our LDAP API, |
| our LDAP API, which provides details of organisations, people and | | which provides details of organisations, people and systems registered |
| systems registered with the Spine.\r\n* [NHAIS GP Links | | with the Spine.\nNHAIS GP Links API - use this to manage GP |
| API](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links) - | | registrations and other patient data in NHAIS.\nOrganisation Data |
| use this to manage GP registrations and other patient data in | | Service - FHIR/ORD API - use this to search a national repository of |
| NHAIS.\r\n* [Organisation Data Service - FHIR/ORD | | |
| APII](https://digital.nhs.uk/pagenotfound) - use this to search a | | |
| national repository of NHS Organisation Reference Data using a FHIR or | | NHS Organisation Reference Data using a FHIR or an ORD |
| an ORD interface.\r\n* [Messaging Exchange for Social care and Health | | interface.\nMessaging Exchange for Social care and Health (MESH) - use |
| veloper/api-catalogue/message-exchange-for-social-care-and-health-api) | | |
| - use this component of the Spine to deliver messages and files to | | this component of the Spine to deliver messages and files to |
| registered recipients, in this case, to send audit information.", | | registered recipients, in this case, to send audit information.", |
| "relationships_as_object": [], | | "relationships_as_object": [], |
| "relationships_as_subject": [], | | "relationships_as_subject": [], |
| "resources": [], | | "resources": [], |
| "standard_category": "Technical standards and specifications", | | "standard_category": "Technical standards and specifications", |
| "state": "active", | | "state": "active", |
| "status": "active", | | "status": "active", |
| "tags": [], | | "tags": [], |
| "title": "GP2GP - HL7 V3 API", | | "title": "GP2GP - HL7 V3 API", |
| "topic": [ | | "topic": [ |
| "Continuity of care (ToC)" | | "Continuity of care (ToC)" |
| ], | | ], |
| "type": "dataset", | | "type": "dataset", |
| "url": null, | | "url": null, |
| "version": null | | "version": null |
| } | | } |