Skip to content

ERSSUP-86837 - Update AG Create/Update/Convert Docs #2394

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
tobycook1 merged 1 commit into from
Aug 21, 2025
+17 −18
Merged

ERSSUP-86837 - Update AG Create/Update/Convert Docs #2394

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
3 changes: 1 addition & 2 deletions specification/components/stu3/schemas/eRS-Communication.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,4 @@ properties:
text:
type: string
example: 'Example content...'


description: 'Maximum 8000 characters.'
4 changes: 2 additions & 2 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 @@ -32,7 +32,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 |
| `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. |
| `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. |
| `requestAttachmentFile` | `0..*` | A set of attachments to be included with the initial request. |
items:
Expand All @@ -42,4 +42,4 @@ properties:
- $ref: 'parameters/Shortlist.yaml'
- $ref: 'parameters/Request.yaml'
- $ref: 'parameters/ReferringClinician.yaml'
- $ref: 'parameters/RequestAttachmentFile.yaml'
- $ref: 'parameters/RequestAttachmentFile.yaml'
16 changes: 8 additions & 8 deletions ...onents/stu3/schemas/eRS-CreateFromCommunicationRequestActionLater-Request-Parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ properties:
type: array
description: |

| Field | Cardinality | Notes |
| --------------------------------- | ----------- | ------------------------------------------ |
| `createFrom` | `1..1` | |
| `guidance` | `1..1` | |
| `newReferralPriority` | `1..1` | |
| `reviewComments` | `1..1` | |
| `guidanceAttachmentFile` | `0..*` | Property defining files to be included with the supplied `guidance` text |
| `reviewAttachmentFile` | `0..*` | Property defining files to be associated with the created `ReferralRequest` |
| Field | Cardinality | Notes |
| --------------------------------- | ----------- | ---------------------------------------------------------------------------------------------- |
| `createFrom` | `1..1` | |
| `guidance` | `1..1` | Mandatory guidance response. Maximum 8000 characters. |
| `newReferralPriority` | `1..1` | |
| `reviewComments` | `1..1` | |
| `guidanceAttachmentFile` | `0..*` | Property defining files to be included with the supplied `guidance` text |
| `reviewAttachmentFile` | `0..*` | Property defining files to be associated with the created `ReferralRequest` |
items:
anyOf:
- title: createFrom
Expand Down
12 changes: 6 additions & 6 deletions ...fication/components/stu3/schemas/eRS-SendCommunicationToRequester-Request-Parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ properties:
type: array
description: |

| Field | Cardinality | Notes |
| --------------------------------- | ----------- | ------------------------------------------ |
| `guidanceOutcome` | `1..1` | |
| Field | Cardinality | Notes |
| --------------------------------- | ----------- | ------------------------------------------------------------------------------------ |
| `guidanceOutcome` | `1..1` | |
| `guidanceIntendedRecommendation` | `0..1` | Conditionally Mandatory if guidanceOutcome value is `RETURN_TO_REFERRER_WITH_ADVICE` |
| `guidance` | `1..1` | |
| `updatedPriority` | `1..1` | |
| `guidanceAttachmentFile` | `0..*` | Property defining files to be included with the supplied `guidance` text |
| `guidance` | `1..1` | Mandatory guidance response. Maximum 8000 characters. |
| `updatedPriority` | `1..1` | |
| `guidanceAttachmentFile` | `0..*` | Property defining files to be included with the supplied `guidance` text |
items:
anyOf:
- title: guidanceOutcome
Expand Down