Skip to content

Commit ecc449d

Browse files
adamtallentire-nhsdnhsd-david-wass
adamtallentire-nhsd
authored and
nhsd-david-wass
committed
[ERSSUP-73911]-[DW]-[Add new content to A008 regarding application-restricted access]-[AST]
1 parent 2cc250c commit ecc449d

File tree

8 files changed

+218
-9
lines changed

8 files changed

+218
-9
lines changed

‎sandbox/src/mocks/stu3/retrieveWorklist/requests/FilteredByService.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"resourceType": "Parameters",
3+
"meta": {
4+
"profile": [
5+
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchWorklist-Parameters-1"
6+
]
7+
},
8+
"parameter": [
9+
{
10+
"name": "listType",
11+
"valueCodeableConcept": {
12+
"coding": [
13+
{
14+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReferralListSelector-1",
15+
"code": "REFERRALS_FOR_REVIEW"
16+
}
17+
]
18+
}
19+
},
20+
{
21+
"name": "service",
22+
"valueIdentifier": {
23+
"system": "http://fhir.nhs.net/Id/ers-service",
24+
"value": "21012"
25+
}
26+
}
27+
]
28+
}

‎sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredByService.json‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
{
2+
"meta": {
3+
"profile": [
4+
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-FetchWorklist-List-1"
5+
]
6+
},
7+
"resourceType": "List",
8+
"contained": [
9+
{
10+
"id": "Practitioner-021600556514",
11+
"meta": {
12+
"profile": [
13+
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Practitioner-1"
14+
]
15+
},
16+
"resourceType": "Practitioner",
17+
"identifier": [
18+
{
19+
"system": "http://fhir.nhs.net/Id/sds-user-id",
20+
"value": "021600556514"
21+
}
22+
]
23+
},
24+
{
25+
"id": "Patient-1000000001",
26+
"meta": {
27+
"profile": [
28+
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Patient-1"
29+
]
30+
},
31+
"resourceType": "Patient",
32+
"identifier": [
33+
{
34+
"system": "http://fhir.nhs.net/Id/nhs-number",
35+
"value": "1000000001"
36+
}
37+
]
38+
}
39+
],
40+
"status": "current",
41+
"mode": "snapshot",
42+
"entry": [
43+
{
44+
"extension": [
45+
{
46+
"extension": [
47+
{
48+
"url": "priority",
49+
"valueCodeableConcept": {
50+
"coding": [
51+
{
52+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-Priority-1",
53+
"code": "ROUTINE"
54+
}
55+
]
56+
}
57+
},
58+
{
59+
"url": "specialty",
60+
"valueCodeableConcept": {
61+
"coding": [
62+
{
63+
"system": "_baseUrl_/STU3/CodeSystem/SPECIALTY",
64+
"code": "CARDIOLOGY"
65+
}
66+
]
67+
}
68+
},
69+
{
70+
"url": "patient",
71+
"valueReference": {
72+
"reference": "#Patient-1000000001"
73+
}
74+
},
75+
{
76+
"url": "allocatedClinician",
77+
"valueReference": {
78+
"reference": "#Practitioner-021600556514"
79+
}
80+
},
81+
{
82+
"url": "eReferralPathwayStart",
83+
"valueDateTime": "2021-09-03T14:09:11.381Z"
84+
},
85+
{
86+
"url": "clinicalInfoPrinted",
87+
"valueBoolean": false
88+
},
89+
{
90+
"url": "requestContextStatus",
91+
"valueCodeableConcept": {
92+
"coding": [
93+
{
94+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-RequestContextStatus-1",
95+
"code": "NEVER_REVIEWED",
96+
"display": "Never Reviewed"
97+
}
98+
]
99+
}
100+
},
101+
{
102+
"url": "clinicalInfoFirstSubmitted",
103+
"valueDateTime": "2021-09-03T14:09:11.022Z"
104+
},
105+
{
106+
"url": "clinicalInfoLastUpdated",
107+
"valueDateTime": "2021-09-03T14:09:12.573Z"
108+
},
109+
{
110+
"url": "appointmentStart",
111+
"valueDateTime": "2021-09-05T15:09:03.971Z"
112+
},
113+
{
114+
"url": "referralType",
115+
"valueCodeableConcept": {
116+
"coding": [
117+
{
118+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReferralType-1",
119+
"code": "APPOINTMENT"
120+
}
121+
]
122+
}
123+
},
124+
{
125+
"url": "service",
126+
"valueReference": {
127+
"identifier": {
128+
"system": "http://fhir.nhs.net/Id/ers-service",
129+
"value": "21012"
130+
},
131+
"display": "Another Excellent Cardiology Business Service 13"
132+
}
133+
}
134+
],
135+
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
136+
}
137+
],
138+
"item": {
139+
"reference": "ReferralRequest/000000070001"
140+
}
141+
}
142+
]
143+
}

‎sandbox/src/mocks/stu3/retrieveWorklist/responses/ReferralsForReview.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,16 @@
220220
}
221221
]
222222
}
223+
},
224+
{
225+
"url": "service",
226+
"valueReference": {
227+
"identifier": {
228+
"system": "http://fhir.nhs.net/Id/ers-service",
229+
"value": "21012"
230+
},
231+
"display": "Another Excellent Cardiology Business Service 13"
232+
}
223233
}
224234
],
225235
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"

‎specification/components/stu3/schemas/eRS-FetchWorklist-Parameters.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ properties:
3131
| Field | Cardinality | Notes |
3232
| --------------------------------- | ----------- | ------------------------------------------ |
3333
| `listType` | `1..1` | |
34-
| `service` | `0..1` | |
34+
| `service` | `0..1` | Mandatory for the application-restricted security pattern |
3535
| `specialtyAssignedIndicator` | `0..1` | |
3636
| `specialty` | `0..1` | |
3737
| `location` | `0..1` | |

‎specification/components/stu3/schemas/endpoints/a008-retrieve-worklist.yaml‎

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ description: |
1010
Worklists provide lists of referral/advice requests that meet certain criteria,
1111
typically where a user needs to be aware of something important, or to undertake an action, in order to avoid delays to patient care.
1212
13-
## Supported security patterns
14-
- Healthcare worker, user-restricted access
15-
1613
## Referring Organisations
1714
Referring organisations can currently access the following referral related worklists:
1815
- The 'Letters Outstanding' worklist contains referrals which require a referral letter to be added.
@@ -22,7 +19,10 @@ description: |
2219
2320
Filters can be used in requests for service provider organisation worklists, however, filters cannot be used in requests for referring organisation worklists.
2421
25-
### Pre-requisites
22+
## Supported security patterns
23+
- Healthcare worker, user-restricted access
24+
25+
## Pre-requisites
2626
In order to use this endpoint and retrieve the referring organisation worklists, you must be an authenticated e-RS user and use one of the following e-RS roles:
2727
- `REFERRING_CLINICIAN`
2828
- `REFERRING_CLINICIAN_ADMIN`
@@ -53,13 +53,32 @@ description: |
5353
5454
## Supported security patterns
5555
- Healthcare worker, user-restricted access
56+
- Application-restricted, unattended access
5657
5758
## Pre-requisites
59+
60+
### Application-restricted access
61+
In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
62+
63+
Supported Worklists:
64+
- Referrals for Review
65+
66+
The Service filter is mandatory when using this security pattern.
67+
68+
This endpoint must only be used to retrieve the worklist for a given service up to two times per day. If this does not meet your requirements, please [[HYPERLINK_CONTACT_US]] to discuss your use case.
69+
70+
If a worklist response exceeds 10MB, a successful response will not be returned. This is due to the size limitation on the APIM platform.
71+
72+
### User-restricted access
5873
In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
5974
- `SERVICE_PROVIDER_CLINICIAN`
6075
- `SERVICE_PROVIDER_ADMIN`
6176
- `SERVICE_PROVIDER_CLINICIAN_ADMIN`
6277
78+
Supported Worklists:
79+
- Referrals for Review
80+
- Appointment Slot Issues
81+
6382
If a worklist response exceeds 10MB, a successful response will not be returned. This is due to the size limitation on the APIM platform.
6483
6584
### Use case
@@ -94,8 +113,8 @@ tags:
94113
- Review referral requests
95114
parameters:
96115
- $ref: '../headers/request/BearerAuthorization.yaml'
97-
- $ref: '../headers/request/OdsCode.yaml'
98-
- $ref: '../headers/request/BusinessFunctionOBO.yaml'
116+
- $ref: '../headers/request/OdsCodeOnlyUserRestricted.yaml'
117+
- $ref: '../headers/request/BusinessFunctionOnlyUserRestricted.yaml'
99118
- $ref: '../headers/request/OnBehalfOfUserID.yaml'
100119
- $ref: '../headers/request/CorrelationID.yaml'
101120
requestBody:
@@ -121,6 +140,10 @@ requestBody:
121140
summary: Filter by clinician
122141
value:
123142
$ref: '../../examples/retrieveWorklist/requests/FilteringByClinician.json'
143+
filtered-by-service:
144+
summary: Filter by service
145+
value:
146+
$ref: '../../examples/retrieveWorklist/requests/FilteredByService.json'
124147
rejected-triage-responses:
125148
summary: Rejected Triage Responses
126149
value:

‎specification/components/stu3/schemas/parameters/ListType.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ properties:
2020
minItems: 1
2121
maxItems: 1
2222
description: |
23+
2324
| Field | Cardinality | Notes |
2425
| -------------------------------- | ----------- | -------------------------------------- |
2526
| `eRS-ReferralListSelector` | `0..1` | |
26-
| `eRS-CommunicationListSelector` | `0..1` | |
27+
| `eRS-CommunicationListSelector` | `0..1` | |
2728
items:
2829
anyOf:
2930
- title: eRS-ReferralListSelector

‎specification/components/stu3/schemas/responses/retrieveWorklist/200Response.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ content:
2727
summary: Filtered by clinician
2828
value:
2929
$ref: '../../../examples/retrieveWorklist/responses/FilteredByClinician.json'
30+
filtered-by-service:
31+
summary: Filtered by service
32+
value:
33+
$ref: '../../../examples/retrieveWorklist/responses/FilteredByService.json'
3034
rejected-triage-responses:
3135
summary: Rejected Triage / Response
3236
value:

‎specification/e-referrals-service-api.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ 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_A024]]</li><li>[[HYPERLINK_A025]]</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_A024]]</li><li>[[HYPERLINK_A025]]</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

0 commit comments

Comments
 (0)