You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/validated-relationships-service-api.yaml
+20-15Lines changed: 20 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,18 @@ info:
6
6
version: 'Computed and injected at build time by `scripts/set_version.py`'
7
7
description: |
8
8
## Overview
9
-
Use this API to access the Validated Relationships Service - the national electronic database of relationships that have been verified for the purpose of enabling individuals to access healthcare services on behalf of (proxy) those they care for.
9
+
Use this API to access the Validated Relationships Service - the national electronic database of relationships
10
+
that have been verified for the purpose of enabling individuals to access healthcare services on behalf of
11
+
those they care for. This is known as acting as a 'Proxy' for those individuals.
10
12
11
13
You can:
12
14
13
-
- search for verified relationships for a given proxy
15
+
- search for validated relationships for a given proxy
14
16
15
17
## Who can use this API
16
-
This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. You must demonstrate you have a valid use case as part of digital onboarding.
17
-
18
+
This API can only be used where there is a legal basis to do so. Make sure you have this and a valid use case before
19
+
you go too far with your development, by [contacting us](https://digital.nhs.uk/developer/help-and-support)
20
+
18
21
You must do this before you can go live (see 'Onboarding' below).
19
22
20
23
## Related APIs
@@ -55,7 +58,16 @@ info:
55
58
56
59
There are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.
57
60
58
-
### Open source
61
+
## Errors
62
+
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
63
+
64
+
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
65
+
* 400 to 499 if it failed because of a client error by your application
66
+
* 500 to 599 if it failed because of an error on our server
67
+
68
+
Errors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.
69
+
70
+
## Open source
59
71
You might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:
60
72
61
73
| Resource | Description | Links |
@@ -114,16 +126,9 @@ info:
114
126
TO BE COMPLETED
115
127
116
128
## Onboarding
117
-
To be completed.
118
-
## Errors
119
-
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
129
+
You must get your software onboarded before it can go live.
120
130
121
-
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
122
-
* 400 to 499 if it failed because of a client error by your application
123
-
* 500 to 599 if it failed because of an error on our server
124
-
125
-
Errors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.
0 commit comments