Skip to content

[RAA-8811]-[]-[Advice clincal intent A044 param]-[DW] #2854

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

Open
dbgwilliamsnhs wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

[RAA-8811]-[]-[Advice clincal intent A044 param]-[DW] #2854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCAWithAttachments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions sandbox/src/mocks/stu3/createAdviceAndGuidance/requests/ExampleRCWithoutAttachments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCAWithAttachments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions sandbox/src/mocks/stu3/createAdviceAndGuidance/responses/ExampleRCWithoutAttachments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions sandbox/src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/MinimalExample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions ...rc/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithAttachmentFileReference.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions ...src/mocks/stu3/retrieveAdviceAndGuidanceRequest/responses/WithUnavailableAttachments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions sandbox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/AttachmentIncluded.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions ...box/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/RequireFurtherInformation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
8 changes: 8 additions & 0 deletions ...ox/src/mocks/stu3/sendAdviceAndGuidanceResponse/responses/ReturnToReferrerWithAdvice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions specification/components/stu3/schemas/eRS-CommunicationRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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'
Expand Down
42 changes: 42 additions & 0 deletions ...ication/components/stu3/schemas/extensions/Extension-eRS-AdviceRequestClinicalIntent.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'
38 changes: 38 additions & 0 deletions specification/components/stu3/schemas/parameters/AdviceRequestClinicalIntent.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'