From ae36412cda731a86727cb30247c07e6705ee8952 Mon Sep 17 00:00:00 2001 From: dbgwilliamsnhs Date: Fri, 31 Jul 2026 16:50:02 +0000 Subject: [PATCH] [RAA-8811]-[]-[Advice clincal intent A044 param]-[DW] --- .../requests/ExampleRCAWithAttachments.json | 7 ++++ .../requests/ExampleRCWithoutAttachments.json | 7 ++++ .../responses/ExampleRCAWithAttachments.json | 8 ++++ .../ExampleRCWithoutAttachments.json | 8 ++++ .../responses/MinimalExample.json | 8 ++++ .../WithAttachmentFileReference.json | 8 ++++ .../responses/WithUnavailableAttachments.json | 8 ++++ .../responses/AttachmentIncluded.json | 8 ++++ .../responses/RequireFurtherInformation.json | 8 ++++ .../responses/ReturnToReferrerWithAdvice.json | 8 ++++ .../schemas/eRS-CommunicationRequest.yaml | 2 + ...eAdviceAndGuidance-Request-Parameters.yaml | 2 + ...nsion-eRS-AdviceRequestClinicalIntent.yaml | 42 +++++++++++++++++++ .../AdviceRequestClinicalIntent.yaml | 38 +++++++++++++++++ 14 files changed, 162 insertions(+) create mode 100644 specification/components/stu3/schemas/extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml create mode 100644 specification/components/stu3/schemas/parameters/AdviceRequestClinicalIntent.yaml diff --git a/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCAWithAttachments.json b/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCAWithAttachments.json index 4a5aa35a6..1cdc2ad0b 100644 --- a/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCAWithAttachments.json +++ b/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCAWithAttachments.json @@ -20,6 +20,13 @@ "code": "AUTHORISED_TO_CONVERT" } }, + { + "name": "adviceRequestClinicalIntent", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED" + } + }, { "name": "shortlist", "resource": { diff --git a/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCWithoutAttachments.json b/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCWithoutAttachments.json index 275e0c536..4aeb3e730 100644 --- a/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCWithoutAttachments.json +++ b/sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCWithoutAttachments.json @@ -20,6 +20,13 @@ "code": "NOT_AUTHORISED_TO_CONVERT" } }, + { + "name": "adviceRequestClinicalIntent", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED" + } + }, { "name": "shortlist", "resource": { diff --git a/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCAWithAttachments.json b/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCAWithAttachments.json index add84144f..47e59655f 100644 --- a/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCAWithAttachments.json +++ b/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCAWithAttachments.json @@ -38,6 +38,14 @@ "display": "Referrer has allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCWithoutAttachments.json b/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCWithoutAttachments.json index 4e1efc822..56e522f2e 100644 --- a/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCWithoutAttachments.json +++ b/sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCWithoutAttachments.json @@ -38,6 +38,14 @@ "display": "Referrer has NOT allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json index 7890cf09b..a3b1bb717 100644 --- a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json +++ b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json @@ -28,6 +28,14 @@ "display": "Referrer has allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json index 6c4c619a7..e20ae7fe0 100644 --- a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json +++ b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json @@ -28,6 +28,14 @@ "display": "Referrer has allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithUnavailableAttachments.json b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithUnavailableAttachments.json index 7a1c14ba4..99b5dcaac 100644 --- a/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithUnavailableAttachments.json +++ b/sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithUnavailableAttachments.json @@ -28,6 +28,14 @@ "display": "Referrer has allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/AttachmentIncluded.json b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/AttachmentIncluded.json index f7a90f5b8..d9d42e858 100644 --- a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/AttachmentIncluded.json +++ b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/AttachmentIncluded.json @@ -38,6 +38,14 @@ "display": "Referrer has NOT allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/RequireFurtherInformation.json b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/RequireFurtherInformation.json index 9fe5add7d..e9063f0f9 100644 --- a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/RequireFurtherInformation.json +++ b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/RequireFurtherInformation.json @@ -38,6 +38,14 @@ "display": "Referrer has NOT allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/ReturnToReferrerWithAdvice.json b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/ReturnToReferrerWithAdvice.json index 2ee34ed54..70824cea6 100644 --- a/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/ReturnToReferrerWithAdvice.json +++ b/sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/ReturnToReferrerWithAdvice.json @@ -38,6 +38,14 @@ "display": "Referrer has NOT allowed the Service Provider to convert the Advice and Guidance to a Referral" } }, + { + "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1", + "valueCoding": { + "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1", + "code": "CONFIRM_REFERRAL_NEEDED", + "display": "Advice to confirm whether a referral is needed" + } + }, { "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralShortlist-1", "valueReference": { diff --git a/specification/components/stu3/schemas/eRS-CommunicationRequest.yaml b/specification/components/stu3/schemas/eRS-CommunicationRequest.yaml index 0679961cf..655bb992f 100644 --- a/specification/components/stu3/schemas/eRS-CommunicationRequest.yaml +++ b/specification/components/stu3/schemas/eRS-CommunicationRequest.yaml @@ -65,12 +65,14 @@ properties: | `Extension-eRS-ReferralShortlist` | `1..1` | | | `Extension-eRS-ReferralPriority` | `1..1` | | | `Extension-eRS-ProviderConversionAuthorisation` | `1..1` | | + | `Extension-eRS-AdviceRequestClinicalIntent` | `1..1` | | | `Extension-eRS-Specialty` | `1..1` | | items: anyOf: - $ref: 'extensions/Extension-eRS-ReferralShortlist.yaml' - $ref: 'extensions/Extension-eRS-ReferralPriority.yaml' - $ref: 'extensions/Extension-eRS-ProviderConversionAuthorisation.yaml' + - $ref: 'extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml' - $ref: 'extensions/Extension-eRS-Specialty.yaml' status: type: string diff --git a/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml b/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml index 715acc2ac..2e4f534bb 100644 --- a/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml +++ b/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml @@ -31,6 +31,7 @@ properties: | --------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `patient` | `1..1` | The patient the Advice request relates to. | | `providerConversionAuthorisation` | `1..1` | A flag detailing whether or not the provider who deals with this advice request is authorised to convert this Advice Request into a Referral | + | `adviceRequestClinicalIntent` | `1..1` | The clinical intent behind raising this Advice Request. | | `shortlist` | `1..1` | A list of services where the Advice Request should be sent to. Note currently only shortlists with a single Service included are supported. | | `request` | `1..1` | An initial message outlining the request. Maximum 8000 characters. | | `referringClinician` | `0..1` | Detail the Referring Clinician that a Referring Clinician Admin is acting on behalf off. Only permitted when creating an Advice Request as a user using the Referring Clinician Admin business function where it is also mandatory. | @@ -39,6 +40,7 @@ properties: anyOf: - $ref: 'parameters/Patient.yaml' - $ref: 'parameters/ProviderConversionAuthorisation.yaml' + - $ref: 'parameters/AdviceRequestClinicalIntent.yaml' - $ref: 'parameters/Shortlist.yaml' - $ref: 'parameters/Request.yaml' - $ref: 'parameters/ReferringClinician.yaml' diff --git a/specification/components/stu3/schemas/extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml b/specification/components/stu3/schemas/extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml new file mode 100644 index 000000000..eea75ff1e --- /dev/null +++ b/specification/components/stu3/schemas/extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml @@ -0,0 +1,42 @@ +title: Extension-eRS-AdviceRequestClinicalIntent +description: Extension to supply the clinical intent of the Advice Request +type: object +required: + - url + - valueCoding +properties: + url: + type: string + enum: + - 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1' + example: 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AdviceRequestClinicalIntent-1' + valueCoding: + type: object + required: + - system + - code + - display + properties: + system: + type: string + enum: + - 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1' + example: 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1' + code: + type: string + description: | + | Code | Description | + | --------------------------- | --------------------------------------------------------------- | + | `MANAGE_IN_PRIMARY_CARE` | Advice to support management in primary care | + | `CONFIRM_REFERRAL_NEEDED` | Advice to confirm whether a referral is needed | + | `INTERIM_AWAITING_REFERRAL` | Interim clinical advice while waiting for a referral appointment | + | `EXISTING_HOSPITAL_PATIENT` | Advice for an existing hospital patient | + enum: + - MANAGE_IN_PRIMARY_CARE + - CONFIRM_REFERRAL_NEEDED + - INTERIM_AWAITING_REFERRAL + - EXISTING_HOSPITAL_PATIENT + example: 'CONFIRM_REFERRAL_NEEDED' + display: + type: string + example: 'Advice to confirm whether a referral is needed' diff --git a/specification/components/stu3/schemas/parameters/AdviceRequestClinicalIntent.yaml b/specification/components/stu3/schemas/parameters/AdviceRequestClinicalIntent.yaml new file mode 100644 index 000000000..bece4d97e --- /dev/null +++ b/specification/components/stu3/schemas/parameters/AdviceRequestClinicalIntent.yaml @@ -0,0 +1,38 @@ +title: AdviceRequestClinicalIntent +description: Parameter to define the clinical intent of the Advice Request +type: object +required: + - name + - valueCoding +properties: + name: + type: string + enum: + - adviceRequestClinicalIntent + example: 'adviceRequestClinicalIntent' + valueCoding: + type: object + required: + - system + - code + properties: + system: + type: string + enum: + - https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1 + example: 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-AdviceRequestClinicalIntent-1' + code: + type: string + description: | + | Code | Description | + | --------------------------- | --------------------------------------------------------------- | + | `MANAGE_IN_PRIMARY_CARE` | Advice to support management in primary care | + | `CONFIRM_REFERRAL_NEEDED` | Advice to confirm whether a referral is needed | + | `INTERIM_AWAITING_REFERRAL` | Interim clinical advice while waiting for a referral appointment | + | `EXISTING_HOSPITAL_PATIENT` | Advice for an existing hospital patient | + enum: + - MANAGE_IN_PRIMARY_CARE + - CONFIRM_REFERRAL_NEEDED + - INTERIM_AWAITING_REFERRAL + - EXISTING_HOSPITAL_PATIENT + example: 'CONFIRM_REFERRAL_NEEDED'