e-referrals-service-api/specification/components/stu3/schemas/eRS-Communication.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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
title: eRS-Communication-1
description: 'A record of information transmitted from a sender to a receiver'
type: object
required:
  - id
  - meta
  - resourceType
  - status
  - category
  - recipient
  - sent
  - sender
  - note
properties:
  id:
    type: string
    example: 'appointment'
  meta:
    type: object
    required:
      - profile
    properties:
      profile:
        type: array
        minItems: 1
        maxItems: 1
        items:
          type: string
          enum:
            - 'https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Communication-1'
            - 'https://fhir.hl7.org.uk/STU3/StructureDefinition/eRS-Communication-1'
          example: 'https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Communication-1'
  resourceType:
    type: string
    enum:
      - Communication
    example: 'Communication'
  status:
    type: string
    enum:
      - completed
    example: completed
  category:
    type: array
    minItems: 1
    maxItems: 1
    items:
      type: object
      required:
        - coding
      properties:
        coding:
          type: array
          minItems: 1
          maxItems: 1
          items:
            type: object
            required:
              - system
              - code
            properties:
              system:
                type: string
                enum:
                  - 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-CommunicationSentBy-1'
                example: 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-CommunicationSentBy-1'
              code:
                type: string
                enum:
                  - 'REQUESTER'
                  - 'RESPONDER'
                  - 'REFERRER_CLINICAL_INFORMATION_UPDATED'
                example: 'REQUESTER'
  recipient:
    type: array
    minItems: 1
    maxItems: 1
    items:
      anyOf:
        - type: object
          required:
            - extension
          properties:
            extension:
              type: array
              minItems: 1
              maxItems: 1
              items:
                $ref: 'extensions/Extension-HealthcareService-Reference.yaml'
        - type: object
          required:
            - identifier
          properties:
            identifier:
              $ref: 'identifiers/Organisation.yaml'
  sent:
    type: string
    format: date-time
    example: '2021-04-20T12:17:35.128Z'
  sender:
    type: object
    required:
      - extension
    properties:
      extension:
        type: array
        minItems: 1
        maxItems: 1
        items:
          $ref: 'extensions/Extension-PractitionerRole-Reference.yaml'
  payload:
    type: array
    items:
      type: object
      required:
        - contentReference
      properties:
        contentReference:
          type: object
          required:
            - reference
          properties:
            reference:
              type: string
              example: 'DocumentReference/70000'
  note:
    type: array
    minItems: 1
    maxItems: 1
    items:
      type: object
      required:
        - text
      properties:
        text:
          type: string
          example: 'Example content...'
          description: 'Maximum 8000 characters.'