diff --git a/specification/components/stu3/schemas/eRS-Communication.yaml b/specification/components/stu3/schemas/eRS-Communication.yaml index 2a3136e17..6941bb4ab 100644 --- a/specification/components/stu3/schemas/eRS-Communication.yaml +++ b/specification/components/stu3/schemas/eRS-Communication.yaml @@ -135,5 +135,4 @@ properties: text: type: string example: 'Example content...' - - + description: 'Maximum 8000 characters.' diff --git a/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml b/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml index 2239d1f60..715acc2ac 100644 --- a/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml +++ b/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml @@ -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: @@ -42,4 +42,4 @@ properties: - $ref: 'parameters/Shortlist.yaml' - $ref: 'parameters/Request.yaml' - $ref: 'parameters/ReferringClinician.yaml' - - $ref: 'parameters/RequestAttachmentFile.yaml' \ No newline at end of file + - $ref: 'parameters/RequestAttachmentFile.yaml' diff --git a/specification/components/stu3/schemas/eRS-CreateFromCommunicationRequestActionLater-Request-Parameters.yaml b/specification/components/stu3/schemas/eRS-CreateFromCommunicationRequestActionLater-Request-Parameters.yaml index 6adff3dc9..29ae37c94 100644 --- a/specification/components/stu3/schemas/eRS-CreateFromCommunicationRequestActionLater-Request-Parameters.yaml +++ b/specification/components/stu3/schemas/eRS-CreateFromCommunicationRequestActionLater-Request-Parameters.yaml @@ -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 diff --git a/specification/components/stu3/schemas/eRS-SendCommunicationToRequester-Request-Parameters.yaml b/specification/components/stu3/schemas/eRS-SendCommunicationToRequester-Request-Parameters.yaml index 9d094a257..c7db3d890 100644 --- a/specification/components/stu3/schemas/eRS-SendCommunicationToRequester-Request-Parameters.yaml +++ b/specification/components/stu3/schemas/eRS-SendCommunicationToRequester-Request-Parameters.yaml @@ -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