e-referrals-service-api/specification/components/stu3/schemas/eRS-CreateAdviceAndGuidance-Request-Parameters.yaml at a139ed0844f0ffca723cc82e58e84a27fe9eeacf · NHSDigital/e-referrals-service-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
title: eRS-CreateAdviceAndGuidance-Request-Parameters
type: object
required:
  - resourceType
  - meta
  - parameter
properties:
  resourceType:
    type: string
    enum:
      - 'Parameters'
    example: 'Parameters'
  meta:
    type: object
    required:
      - profile
    properties:
      profile:
        type: array
        items:
          type: string
          enum:
            - https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CreateAdviceAndGuidance-Request-Parameters-1
          example: 'https://fhir.nhs.uk/STU3/StructureDefinition/eRS-CreateAdviceAndGuidance-Request-Parameters-1'
        minItems: 1
        maxItems: 1
  parameter:
    type: array
    description: |
      | Field                             | Cardinality | Notes                                                                                                                                                                                                                               |
      | --------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | `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. 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:
      anyOf:
        - $ref: 'parameters/Patient.yaml'
        - $ref: 'parameters/ProviderConversionAuthorisation.yaml'
        - $ref: 'parameters/Shortlist.yaml'
        - $ref: 'parameters/Request.yaml'
        - $ref: 'parameters/ReferringClinician.yaml'
        - $ref: 'parameters/RequestAttachmentFile.yaml'