e-referrals-service-api/specification/components/stu3/schemas/eRS-SendCommunicationToRequester-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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
title: eRS-SendCommunicationToRequester-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-SendCommunicationToRequester-Request-Parameters-1"
          example: "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-SendCommunicationToRequester-Request-Parameters-1"
        minItems: 1
        maxItems: 1
  parameter:
    type: array
    description: |

      | Field                             | Cardinality | Notes                                                                                |
      | --------------------------------- | ----------- | ------------------------------------------------------------------------------------ |
      | `guidanceOutcome`                 | `1..1`      |                                                                                      |
      | `guidanceIntendedRecommendation`  | `0..1`      | Conditionally Mandatory if guidanceOutcome value is `RETURN_TO_REFERRER_WITH_ADVICE` |
      | `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
          description: Parameter indicating the expected outcome of the supplied guidance
          type: object
          required:
            - name
            - valueCoding
          properties:
            name:
              type: string
              enum:
                - guidanceOutcome
              example: 'guidanceOutcome'
            valueCoding:
              type: object
              required:
                - system
                - code
              properties:
                system:
                  type: string
                  enum:
                    - https://fhir.nhs.uk/STU3/CodeSystem/eRS-GuidanceResponseOutcome-1
                  example: https://fhir.nhs.uk/STU3/CodeSystem/eRS-GuidanceResponseOutcome-1
                code:
                  type: string
                  enum:
                    - RETURN_TO_REFERRER_WITH_ADVICE
                    - REQUIRE_FURTHER_INFORMATION
                    - PROVIDER_CONVERTED
                  example: RETURN_TO_REFERRER_WITH_ADVICE
        - title: guidanceIntendedRecommendation
          description: Parameter to supply the recommendation for a patient's care off the back of the provided guidance. Only available and mandatory when supplying a `guidanceOutcome` of `RETURN_TO_REFERRER_WITH_ADVICE`
          type: object
          required:
            - name
            - valueCoding
          properties:
            name:
              type: string
              enum:
                - guidanceIntendedRecommendation
              example: 'guidanceIntendedRecommendation'
            valueCoding:
              type: object
              required:
                - system
                - code
              properties:
                system:
                  type: string
                  enum:
                    - https://fhir.nhs.uk/STU3/CodeSystem/eRS-GuidanceIntendedRecommendation-1
                  example: https://fhir.nhs.uk/STU3/CodeSystem/eRS-GuidanceIntendedRecommendation-1
                code:
                  type: string
                  enum:
                    - ADVICE_ONLY_NO_REFERRAL_RECOMMENDED
                    - ADVICE_FOLLOWED_BY_REFERRAL_IF_REQUIRED
                    - REFERRAL_RECOMMENDED
                    - OTHER
                  example: ADVICE_ONLY_NO_REFERRAL_RECOMMENDED
        - $ref: 'parameters/Guidance.yaml'
        - title: updatedPriority
          description: Parameter to supply a updatedPriority
          type: object
          required:
            - name
            - valueCoding
          properties:
            name:
              type: string
              enum:
                - updatedPriority
              example: 'updatedPriority'
            valueCoding:
              $ref: 'codings/Priority.yaml'
        - $ref: 'parameters/GuidanceAttachmentFile.yaml'