Skip to content

[RAA-703] Update OAS docs for available actions and cancel referral #2669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolebalmer1-nhs merged 4 commits into from
Jan 30, 2026
Merged

[RAA-703] Update OAS docs for available actions and cancel referral #2669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5530eb
[RAA-703] Update OAS docs for available actions and cancel referral
nicolebalmer1-nhs Nov 20, 2025
97133a8
[RAA-703] Further updates
nicolebalmer1-nhs Jan 15, 2026
2a801a5
[RAA-703] Fix wording
nicolebalmer1-nhs Jan 16, 2026
e876df6
RAA-703 Fix failing test
nicolebalmer1-nhs Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions sandbox/src/mocks/stu3/cancelReferral/requests/bookedOutsideCabWithoutComment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CancelReferral-Request-Parameters-1"
]
},
"resourceType": "Parameters",
"parameter": [
{
"name": "cancellationReason",
"valueCoding": {
"system": "_baseurl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
"code": "BOOKED_OUTSIDE_CAB"
}
}
]
}
21 changes: 21 additions & 0 deletions sandbox/src/mocks/stu3/cancelReferral/requests/outpatientService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CancelReferral-Request-Parameters-1"
]
},
"resourceType": "Parameters",
"parameter": [
{
"name": "cancellationReason",
"valueCoding": {
"system": "_baseurl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
"code": "OUTPATIENT_SERVICE_NA"
}
},
{
"name": "cancellationComments",
"valueString": "This is a cancellation reason comment"
}
]
}
170 changes: 170 additions & 0 deletions .../mocks/stu3/cancelReferral/responses/CancelledReferralBookedOutsideCabWithoutComment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
{
"meta": {
Comment thread
nicolebalmer1-nhs marked this conversation as resolved.
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CancelReferral-Response-Parameters-1"
]
},
"resourceType": "Parameters",
"parameter": [
{
"name": "updatedReferralRequest",
"resource": {
"id": "000000070000",
"meta": {
"versionId": "4",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ReferralRequest-1"
]
},
"resourceType": "ReferralRequest",
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralPriority-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-Priority-1",
"code": "ROUTINE",
"display": "Routine"
}
]
}
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1",
"valueReference": {
"reference": "#shortlist"
}
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-Commissioning-Rule-Org-1",
"valueIdentifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "R69"
}
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralState-1",
"extension": [
{
"url": "state",
"valueCoding": {
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReferralState-1",
"code": "CANCELLED_REFERRAL",
"display": "Cancelled Referral"
}
},
{
"url": "reason",
"valueCoding": {
"system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
"code": "BOOKED_OUTSIDE_CAB",
"display": "Patient booked outside NHS e-Referral Service"
}
}
]
}
],
"contained": [
{
"id": "serviceSearchCriteria",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-ServiceSearchCriteria-Parameters-1"
]
},
"resourceType": "Parameters",
"parameter": [
{
"name": "priority",
"valueCoding": {
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-Priority-1",
"code": "ROUTINE"
}
},
{
"name": "specialty",
"valueCoding": {
"system": "_baseUrl_/STU3/CodeSystem/SPECIALTY",
"code": "CARDIOLOGY"
}
},
{
"name": "clinicType",
"valueCoding": {
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ClinicType-1",
"code": "HEART_FAILURE"
}
},
{
"name": "ageAndGenderAppropriate",
"valueBoolean": false
},
{
"name": "commissioningProvisioning",
"valueCoding": {
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-CommissioningProvisioning-1",
"code": "ALL_AVAILABLE_FOR_BOOKING"
}
}
]
},
{
"id": "shortlist",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Shortlist-List-1"
]
},
"resourceType": "List",
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-Shortlist-SearchCriteria-1",
"valueReference": {
"reference": "#serviceSearchCriteria"
}
}
],
"status": "current",
"mode": "snapshot",
"entry": [
{
"item": {
"identifier": {
"system": "http://fhir.nhs.net/Id/ers-service",
"value": "11004"
},
"display": "Cardiology Triage Business Service"
}
}
]
}
],
"status": "cancelled",
"specialty": {
"coding": [
{
"system": "_baseUrl_/STU3/CodeSystem/SPECIALTY",
"code": "CARDIOLOGY",
"display": "Cardiology"
}
]
},
"subject": {
"identifier": {
"system": "http://fhir.nhs.net/Id/nhs-number",
"value": "9912003888"
}
},
"supportingInfo": [],
"intent": "plan",
"identifier":[
{
"system":"https://fhir.nhs.uk/Id/ers-request-id",
"value":"r.c18c4ec4-7d0a-480e-8506-347e0ec228b0"
}
]
}
}
]
}
Loading