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

Condition $write

post/Condition/$write
Page View

This resource contains details of a clinical diagnosis, problem, or other concept that needs to be conveyed for context about a patient’s wellness. This could be sent prior to a patient visit or received as a follow-up. A condition may or may not be related to a specific encounter, and the details may be about a condition that's active, resolved, or recurring.  

You can receive, retrieve, or save condition information.

$write

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

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Condition/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxConditionMessageBundleExample",
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": "Condition-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "Condition",
28
        "id": "RedoxProblemConditionExamplePneumonia",
29
        "category": [
30
          {
31
            "coding": [
32
              {
33
                "code": "problem-list-item",
34
                "system": "http://terminology.hl7.org/CodeSystem/condition-category"
35
              }
36
            ]
37
          }
38
        ],
39
        "identifier": [
40
          {
41
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.768076",
42
            "value": "1248190455"
43
          }
44
        ],
45
        "subject": {
46
          "reference": "Patient/RedoxPatientExampleTimothy"
47
        },
48
        "clinicalStatus": {
49
          "coding": [
50
            {
51
              "code": "resolved",
52
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical"
53
            }
54
          ]
55
        },
56
        "code": {
57
          "coding": [
58
            {
59
              "code": "233604007",
60
              "system": "http://snomed.info/sct"
61
            }
62
          ],
63
          "text": "Pneumonia"
64
        },
65
        "onsetDateTime": "2012-08-06T04:00:00.000Z",
66
        "abatementDateTime": "2012-08-06T04:00:00.000Z"
67
      }
68
    },
69
    {
70
      "resource": {
71
        "resourceType": "Patient",
72
        "id": "RedoxPatientExampleTimothy",
73
        "meta": {
74
          "extension": [
75
            {
76
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
77
              "valueInteger": 1
78
            }
79
          ]
80
        },
81
        "extension": [
82
          {
83
            "extension": [
84
              {
85
                "url": "text",
86
                "valueString": "White"
87
              }
88
            ],
89
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
90
          },
91
          {
92
            "extension": [
93
              {
94
                "url": "ombCategory",
95
                "valueCoding": {
96
                  "code": "2135-2",
97
                  "system": "urn:oid:2.16.840.1.113883.6.238",
98
                  "display": "Hispanic or Latino"
99
                }
100
              },
101
              {
102
                "url": "text",
103
                "valueString": "Hispanic"
104
              }
105
            ],
106
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
107
          }
108
        ],
109
        "identifier": [
110
          {
111
            "value": "0000000001",
112
            "system": "urn:redox:health-one:MR"
113
          },
114
          {
115
            "value": "101-01-0001",
116
            "system": "http://hl7.org/fhir/sid/us-ssn"
117
          }
118
        ],
119
        "name": [
120
          {
121
            "given": [
122
              "Timothy",
123
              "Paul"
124
            ],
125
            "family": "Bixby",
126
            "use": "official"
127
          },
128
          {
129
            "text": "Billy",
130
            "use": "usual"
131
          }
132
        ],
133
        "gender": "male",
134
        "birthDate": "2008-01-06",
135
        "telecom": [
136
          {
137
            "value": "+18088675301",
138
            "system": "phone",
139
            "use": "home"
140
          },
141
          {
142
            "value": "+18008675309",
143
            "system": "phone",
144
            "use": "work"
145
          },
146
          {
147
            "value": "timothy.bixby@redoxengine.com",
148
            "system": "email"
149
          }
150
        ],
151
        "address": [
152
          {
153
            "line": [
154
              "4762 Hickory Street"
155
            ],
156
            "city": "Monroe",
157
            "district": "Greene",
158
            "state": "WI",
159
            "postalCode": "53566",
160
            "country": "US",
161
            "use": "home"
162
          }
163
        ],
164
        "maritalStatus": {
165
          "coding": [
166
            {
167
              "code": "M",
168
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
169
              "display": "Married"
170
            }
171
          ],
172
          "text": "Married"
173
        },
174
        "communication": [
175
          {
176
            "language": {
177
              "coding": [
178
                {
179
                  "code": "en",
180
                  "system": "urn:ietf:bcp:47"
181
                }
182
              ],
183
              "text": "English"
184
            }
185
          }
186
        ],
187
        "contact": [
188
          {
189
            "name": {
190
              "given": [
191
                "Barbara"
192
              ],
193
              "family": "Bixby"
194
            },
195
            "telecom": [
196
              {
197
                "value": "+18088675303",
198
                "system": "phone",
199
                "use": "home"
200
              },
201
              {
202
                "value": "barbara.bixby@redoxengine.com",
203
                "system": "email"
204
              }
205
            ],
206
            "address": {
207
              "line": [
208
                "4762 Hickory St."
209
              ],
210
              "city": "Monroe",
211
              "district": "Green",
212
              "state": "WI",
213
              "postalCode": "53566",
214
              "country": "USA"
215
            },
216
            "relationship": [
217
              {
218
                "coding": [
219
                  {
220
                    "code": "MTH",
221
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
222
                    "display": "mother"
223
                  }
224
                ],
225
                "text": "Mother"
226
              },
227
              {
228
                "coding": [
229
                  {
230
                    "code": "C",
231
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
232
                    "display": "Emergency Contact"
233
                  }
234
                ],
235
                "text": "Emergency Contact"
236
              }
237
            ]
238
          }
239
        ],
240
        "generalPractitioner": [
241
          {
242
            "reference": "Practitioner/RedoxPractitionerExamplePat"
243
          }
244
        ],
245
        "managingOrganization": {
246
          "reference": "Organization/RedoxOrganizationManagingExample"
247
        }
248
      }
249
    }
250
  ]
251
}'

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, Condition, Patient or Other

    An array of FHIR resources. At a minium, a Condition should include the following entries:

    • Condition - The condition being described
    • Patient - The patient who has the condition

    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).

  • 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"