Skip to content

Commit c0d3181

Browse files
[ERSSUP-89265]-[MW]-[Updated Accept Referral endpoint documentation to highlight it can be accessed via App-Restricted access]-[JW]
1 parent 4bb6f22 commit c0d3181

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

specification/components/stu3/schemas/endpoints/a013-accept-referral.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ description: |
66
77
## Supported security patterns
88
- Healthcare worker, user-restricted access
9+
- Application-restricted, unattended access
910
1011
## Pre-requisites
12+
### Healthcare worker, user-restricted access
1113
In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
1214
- `SERVICE_PROVIDER_CLINICIAN`
1315
- `SERVICE_PROVIDER_CLINICIAN_ADMIN`
16+
17+
### Application-restricted, unattended access
18+
In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
19+
20+
To access this endpoint in application-restricted, unattended mode, you will be required to submit your use case for review.
1421
1522
## Important notes
1623

specification/e-referrals-service-api.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,19 @@ info:
5959
6060
| Access mode | Authentication via | Functions | Availability |
6161
| ----------------------------- | -------------------------- | ----------------------- | ------------------------------- |
62-
| Application-restricted,<br/>unattended access | [[HYPERLINK_SIGNED_JWT]] | <ul><li>[[HYPERLINK_A004]]</li><li>[[HYPERLINK_A005]]</li><li>[[HYPERLINK_A006]]</li><li>[[HYPERLINK_A007]]</li><li>[[HYPERLINK_A008]]</li><li>[[HYPERLINK_A024]]</li><li>[[HYPERLINK_A025]]</li><li>[[HYPERLINK_A028]]</li><li>[[HYPERLINK_A029]]</li><li>[[HYPERLINK_A033]]</li><li>[[HYPERLINK_A035]]</li><li>[[HYPERLINK_A037]]</li><li>[[HYPERLINK_A043]]</li></ul> | [[HYPERLINK_PRODUCTION]] |
62+
| Application-restricted,<br/>unattended access | [[HYPERLINK_SIGNED_JWT]] | <ul><li>[[HYPERLINK_A004]]</li><li>[[HYPERLINK_A005]]</li><li>[[HYPERLINK_A006]]</li><li>[[HYPERLINK_A007]]</li><li>[[HYPERLINK_A008]]</li><li>[[HYPERLINK_A013]]</li><li>[[HYPERLINK_A024]]</li><li>[[HYPERLINK_A025]]</li><li>[[HYPERLINK_A028]]</li><li>[[HYPERLINK_A029]]</li><li>[[HYPERLINK_A033]]</li><li>[[HYPERLINK_A035]]</li><li>[[HYPERLINK_A037]]</li><li>[[HYPERLINK_A043]]</li></ul> | [[HYPERLINK_PRODUCTION]] |
6363
| Healthcare worker,<br/>user-restricted access | [[HYPERLINK_CIS_AUTH_SHORT]] | All Endpoints | [[HYPERLINK_PRODUCTION]] |
6464
6565
##### Application-restricted, unattended access
6666
6767
This access mode has been introduced to allow a Partner application which has been [registered with us](https://portal.developer.nhs.uk/create-a-developer-account) and [authenticated via signed JWT](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) to interact with a subset of e-RS FHIR API endpoints in an unattended and read-only fashion.
6868
Application-restricted, unattended access should only be used when authenticating a human user (for example via smartcard) is not possible.
6969
70-
Write operations are currently only supported by [[HYPERLINK_A028]] for non-clinical use cases. You will be required to submit your use case for review when using this endpoint via application-restricted, unattended access.
70+
Write operations are currently supported for specific use cases via:
71+
- [[HYPERLINK_A028]]
72+
- [[HYPERLINK_A013]]
73+
74+
You will be required to submit your use case for review when using this endpoint via application-restricted, unattended access.
7175
7276
##### Healthcare worker, user-restricted access
7377
@@ -122,6 +126,7 @@ info:
122126
- [[HYPERLINK_A006]]
123127
- [[HYPERLINK_A007]]
124128
- [[HYPERLINK_A008]]
129+
- [[HYPERLINK_A013]]
125130
- [[HYPERLINK_A024]]
126131
- [[HYPERLINK_A025]]
127132
- [[HYPERLINK_A028]]

0 commit comments

Comments
 (0)