Home
API reference
FHIR® API
FHIR® resources
AllergyIntolerance
$write

AllergyIntolerance $write

post/AllergyIntolerance/$write
Page View

This resource contains recorded details about a patient’s allergy or intolerance to medication, food, materials, or other substances. It provides a holistic view of a documented allergy so that you know whether the allergy is current and needs to be treated, or how severe the patient’s reaction may be for a given allergy. A documented allergy may be active or resolved, and the patient’s reaction may be anywhere from moderate to severe. 

You can retrieve, receive, or save allergy information.

$write

This operation allows you to save new or updated allergy details to a patient’s chart.

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/AllergyIntolerance/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "AllergyIntoleranceMessageBundleExample",
8
  "type": "message",
9
  "timestamp": "2021-12-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventCoding": {
20
          "system": "urn:redox:event-type",
21
          "code": "AllergyIntolerance-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "AllergyIntolerance",
28
        "id": "AllergyExample",
29
        "identifier": [
30
          {
31
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
32
            "value": "35892347"
33
          }
34
        ],
35
        "clinicalStatus": {
36
          "coding": [
37
            {
38
              "code": "active",
39
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
40
              "display": "Active"
41
            }
42
          ],
43
          "text": "Active"
44
        },
45
        "type": "allergy",
46
        "_type": {
47
          "extension": [
48
            {
49
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
50
              "valueString": "Propensity to adverse reaction to drug"
51
            }
52
          ]
53
        },
54
        "criticality": "low",
55
        "code": {
56
          "coding": [
57
            {
58
              "code": "2670",
59
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
60
              "display": "Codeine"
61
            }
62
          ],
63
          "text": "Codeine"
64
        },
65
        "patient": {
66
          "reference": "Patient/RedoxPatientExampleTimothy"
67
        },
68
        "encounter": {
69
          "reference": "Encounter/RedoxEncompassingEncounterExample"
70
        },
71
        "onsetDateTime": "2022-01-03T16:30:00.000Z",
72
        "reaction": [
73
          {
74
            "manifestation": [
75
              {
76
                "coding": [
77
                  {
78
                    "code": "267036007",
79
                    "system": "http://snomed.info/sct",
80
                    "display": "Shortness of Breath"
81
                  }
82
                ]
83
              }
84
            ],
85
            "description": "Shortness of Breath",
86
            "severity": "moderate",
87
            "_severity": {
88
              "extension": [
89
                {
90
                  "url": "http://hl7.org/fhir/StructureDefinition/originalText",
91
                  "valueString": "Mild to moderate"
92
                }
93
              ]
94
            }
95
          }
96
        ],
97
        "note": [
98
          {
99
            "text": "Additional information"
100
          }
101
        ]
102
      }
103
    },
104
    {
105
      "resource": {
106
        "resourceType": "Patient",
107
        "id": "RedoxPatientExampleTimothy",
108
        "meta": {
109
          "extension": [
110
            {
111
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
112
              "valueInteger": 1
113
            }
114
          ]
115
        },
116
        "extension": [
117
          {
118
            "extension": [
119
              {
120
                "url": "text",
121
                "valueString": "White"
122
              }
123
            ],
124
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
125
          },
126
          {
127
            "extension": [
128
              {
129
                "url": "ombCategory",
130
                "valueCoding": {
131
                  "code": "2135-2",
132
                  "system": "urn:oid:2.16.840.1.113883.6.238",
133
                  "display": "Hispanic or Latino"
134
                }
135
              },
136
              {
137
                "url": "text",
138
                "valueString": "Hispanic"
139
              }
140
            ],
141
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
142
          }
143
        ],
144
        "identifier": [
145
          {
146
            "value": "0000000001",
147
            "system": "urn:redox:health-one:MR"
148
          },
149
          {
150
            "value": "101-01-0001",
151
            "system": "http://hl7.org/fhir/sid/us-ssn"
152
          }
153
        ],
154
        "name": [
155
          {
156
            "given": [
157
              "Timothy",
158
              "Paul"
159
            ],
160
            "family": "Bixby",
161
            "use": "official"
162
          },
163
          {
164
            "text": "Billy",
165
            "use": "usual"
166
          }
167
        ],
168
        "gender": "male",
169
        "birthDate": "2008-01-06",
170
        "telecom": [
171
          {
172
            "value": "+18088675301",
173
            "system": "phone",
174
            "use": "home"
175
          },
176
          {
177
            "value": "+18008675309",
178
            "system": "phone",
179
            "use": "work"
180
          },
181
          {
182
            "value": "timothy.bixby@redoxengine.com",
183
            "system": "email"
184
          }
185
        ],
186
        "address": [
187
          {
188
            "line": [
189
              "4762 Hickory Street"
190
            ],
191
            "city": "Monroe",
192
            "district": "Greene",
193
            "state": "WI",
194
            "postalCode": "53566",
195
            "country": "US",
196
            "use": "home"
197
          }
198
        ],
199
        "maritalStatus": {
200
          "coding": [
201
            {
202
              "code": "M",
203
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
204
              "display": "Married"
205
            }
206
          ],
207
          "text": "Married"
208
        },
209
        "communication": [
210
          {
211
            "language": {
212
              "coding": [
213
                {
214
                  "code": "en",
215
                  "system": "urn:ietf:bcp:47"
216
                }
217
              ],
218
              "text": "English"
219
            }
220
          }
221
        ],
222
        "contact": [
223
          {
224
            "name": {
225
              "given": [
226
                "Barbara"
227
              ],
228
              "family": "Bixby"
229
            },
230
            "telecom": [
231
              {
232
                "value": "+18088675303",
233
                "system": "phone",
234
                "use": "home"
235
              },
236
              {
237
                "value": "barbara.bixby@redoxengine.com",
238
                "system": "email"
239
              }
240
            ],
241
            "address": {
242
              "line": [
243
                "4762 Hickory St."
244
              ],
245
              "city": "Monroe",
246
              "district": "Green",
247
              "state": "WI",
248
              "postalCode": "53566",
249
              "country": "USA"
250
            },
251
            "relationship": [
252
              {
253
                "coding": [
254
                  {
255
                    "code": "MTH",
256
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
257
                    "display": "mother"
258
                  }
259
                ],
260
                "text": "Mother"
261
              },
262
              {
263
                "coding": [
264
                  {
265
                    "code": "C",
266
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
267
                    "display": "Emergency Contact"
268
                  }
269
                ],
270
                "text": "Emergency Contact"
271
              }
272
            ]
273
          }
274
        ],
275
        "generalPractitioner": [
276
          {
277
            "reference": "Practitioner/RedoxPractitionerExamplePat"
278
          }
279
        ],
280
        "managingOrganization": {
281
          "reference": "Organization/RedoxOrganizationManagingExample"
282
        }
283
      }
284
    }
285
  ]
286
}'

Request Body Schema

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of MessageHeader, AllergyIntolerance, Patient or Other

    An array of FHIR resources. At a minimum, an AllergyIntolerance should include the following entries:

    • AllergyIntolerance - The allergy or intolerance being described
    • Patient - The patient who has the allergy or intolerance

    If other resources are included, due to being referenced within an entry, they should conform to the applicable Redox profile.

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          Value: AllergyIntolerance-New
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

1
"Operation Response"