Home
How to use Redox
Interact with clinical networks
Onramp to TEFCA-CommonWell
Maintain your Redox repository for TEFCA-CommmonWell

Maintain your Redox repository for TEFCA-CommmonWell

Last updated: Mar 18, 2026
DEVELOPER
HEALTH TECH VENDOR

All TEFCA-CommonWell participants must respond to requests they receive from other network participants. In some cases, you may receive a high volume of requests per day.

With Redox as your responder, we can respond to incoming patient requests on your behalf. But you must push patient records and documents to your Redox repository so that we can maintain an accurate representation of each of your patients.

Prerequisites

  • Make sure the patient demographic details are up-to-date with any relevant PatientAdmin messages. Learn how to populate your patient repository.
  • (Optional) Test sending these requests with our TEFCA-CommonWell sandbox.

Save patient documents

After providing care for a patient, save the patient summary documents to your data on demand repository so that we can respond to requests for documents.

We recommend using the ClinicalSummary.VisitPush request with all the available unique clinical information that you produce.

Be mindful of these requirements and best practices:

FIeldNotes
Header.Patient.Identifiers[].IDTypeAt least one patient identifier should include an ID Type that matches the patient identification OID used in the PatientAdmin messages.
Header.Document.IDThis ID must be globally unique across TEFCA-CommonWell as either a GUID or an internally unique ID prefixed with your organizational OID. Our examples use the OID prefix.
Header.Document.TypeHeader.Document.TypeCodeThese values should be a LOINC code. Typically, you should use the code for a Continuity of Care Document (i.e., 34133-9). When sending a document related to a single patient visit, you should use these codes: Use Progress Notes (i.e., 11506-3) for outpatient/ambulatory visits.Use discharge summary (i.e., 18842-5) for inpatient/hospital visits.
Header.Document.Custodian.NameWe recommend populating this value since it tells other clinical network participants where the data came from. If this field isn’t populated, the value defaults to the Meta.Source.Name, which is set based on the source you’re sending the request from. We encourage you to populate as much of the Header.Document.Custodian.Name object as possible. Most entries use the same data as their directory, but you may want more or less granularity.
Documents[].Author.LocationSome external systems use this to display the location the document originated from when viewing a list documents. When looking at an individual document, Custodian.Name is typically used instead. Typically, the Author and Custodian values are the same, but they may differ. If not supplied, Redox sets this to the directory entry name you’ve saved to TEFCA-CommonWell.See the difference between Author and Custodian.

Since ClinicalSummary.VisitPush is lengthy, we include an abbreviated example below. Check out an unabbreviated example or view the Postman package.

Example: Save a patient document (abbreviated)
bash
1
curl \
2
-X POST https://api.redoxengine.com/endpoint \
3
-H "Content-Type: application/json" \
4
-H "Authorization: Bearer $API_TOKEN" \
5
-d '{
6
    "Meta": {
7
        "DataModel": "Clinical Summary",
8
        "EventType": "VisitPush",
9
        # Remove in production
10
        "Test": true,
11
        "Destinations": [
12
            {
13
                // This is your repository destination ID (and will change for production).
14
                "ID": "{{repository-destination-id}}"
15
            }
16
        ]
17
    },
18
    // Everything below should be set as appropriate for your organization. Review our API reference for supported patient demographics.
19
    "Header": {
20
        "DirectAddressFrom": null,
21
        "DirectAddressTo": null,
22
        "Document": {
23
            "Author": {
24
                "ID": "4356789876",
25
                "IDType": "NPI",
26
                "Type": null,
27
                "FirstName": "Pat",
28
                "LastName": "Granite",
29
                "Credentials": [
30
                    "MD"
31
                ],
32
                "Address": {
33
                    "StreetAddress": "123 Main St.",
34
                    "City": "Madison",
35
                    "State": "WI",
36
                    "ZIP": "53703",
37
                    "County": "Dane",
38
                    "Country": "USA"
39
                },
40
                "EmailAddresses": [],
41
                "PhoneNumber": {
42
                    "Office": "+16085551234"
43
                },
44
                "Location": { ...
45
                }
46
            },
47
            "ID": "{{redoxDevDocumentOid}}^67890",
48
            "Locale": "US",
49
            "Title": "Community Health and Hospitals: Annual Physical",
50
            "DateTime": "2012-09-12T00:00:00.000Z",
51
            "Type": "Progress Note",
52
            "TypeCode": {
53
                "Code": "18842-5",
54
                "CodeSystem": "2.16.840.1.113883.6.1",
55
                "CodeSystemName": "LOINC",
56
                "Name": "Progress Note"
57
            },
58
            "Visit": {
59
                "Location": {
60
                    "Type": "Outpatient Clinic",
61
                    "Facility": "RHS Vista Oaks Clinic",
62
                    "Department": "Vista Oaks Clinic",
63
                    "Room": null
64
                },
65
                "StartDateTime": "2020-11-12T00:18:30.592Z",
66
                "EndDateTime": "2020-11-12T00:18:30.592Z",
67
                "Reason": "Annual Physical",
68
                "VisitNumber": "30311442"
69
            }
70
        },
71
        "Patient": {
72
            "Identifiers": [
73
                {
74
                    "ID": "1234",
75
                    "IDType": "{{redoxDevPatientOid}}"
76
                }
77
            ],
78
            "FirstName": "Timothy",
79
            "MiddleName": "Paul",
80
            "LastName": "Bixby",
81
            "DOB": "2008-01-06",
82
            "SSN": "101-01-0001",
83
            "Sex": "Male",
84
            "Race": "White",
85
            "IsHispanic": null,
86
            "MaritalStatus": "Married",
87
            "IsDeceased": null,
88
            "DeathDateTime": null,
89
            "PhoneNumber": {
90
                "Home": "+18088675301",
91
            },
92
            "EmailAddresses": [],
93
            "Language": "en",
94
            "Citizenship": [],
95
            "Address": {
96
                "StreetAddress": "4762 Hickory Street",
97
                "City": "Monroe",
98
                "State": "WI",
99
                "ZIP": "53566",
100
                "County": "Green",
101
                "Country": "US"
102
            }
103
        },
104
        "PCP": { ...
105
        }
106
    },
107
    "AdvanceDirectivesText": "
108
Directive	Description	Verification	Supporting Document(s)
109
Resuscitation status	Do not resuscitate	Dr. Robert Dolin, Nov 07, 1999	Advance directive
110
",
111
    "AdvanceDirectives": [
112
        {
113
            "Type": {
114
                "Code": "304251008",
115
                "CodeSystem": "2.16.840.1.113883.6.96",
116
                "CodeSystemName": "SNOMED CT",
117
                "Name": "Resuscitation",
118
                "AltCodes": []
119
            },
120
            "Code": "304253006",
121
            "CodeSystem": "2.16.840.1.113883.6.96",
122
            "CodeSystemName": "SNOMED CT",
123
            "Name": "Do not resuscitate",
124
            "AltCodes": [],
125
            "StartDate": "2011-02-13T05:00:00.000Z",
126
            "EndDate": null,
127
            "ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf",
128
            "VerifiedBy": [
129
                {
130
                    "FirstName": "Robert",
131
                    "LastName": "Dolin",
132
                    "Credentials": "Dr.",
133
                    "DateTime": null
134
                }
135
            ],
136
            "Custodians": [
137
                {
138
                    "FirstName": "Robert",
139
                    "LastName": "Dolin",
140
                    "Credentials": "Dr.",
141
                    "Address": { ...
142
                    }
143
                }
144
            ]
145
        }
146
    ],
147
    "AllergyText": "
148
Substance	Reaction	Severity	Status
149
Penicillin G benzathine	Hives	Moderate to severe	Inactive
150
Codeine	Shortness of Breath	Moderate	Active
151
Aspirin	Hives	Mild to moderate	Active
152
",
153
    "Allergies": [ ...
154
            ] ...
155
        }
156
    ],
157
    "AssessmentText": "Recurrent GI bleed of unknown etiology; hypotension perhaps secondary to this but as likely secondary to polypharmacy.Acute on chronic anemia secondary to #1.Azotemia, acute renal failure with volume loss secondary to #1.Hyperkalemia secondary to #3 and on ACE and K+ supplement.Other chronic diagnoses as noted above, currently stable.Also, this person has back problems.",
158
    "Assessment": {
159
        "Diagnoses": [
160
            {
161
                "Value": "Displacement of lumbar intervertebral disc without myelopathy",
162
                "DateTime": "2009-11-01T05:00:00.000Z",
163
                "IsNegativeIndicator": false,
164
                "Codes": [
165
                    {
166
                        "Code": "202708005",
167
                        "CodeSystem": "2.16.840.1.113883.6.96",
168
                        "CodeSystemName": "SNOMED-CT",
169
                        "Name": "Herniated lumbar intervertebral disc"
170
                    }, 
171
                    { ...
172
                    }
173
                ]
174
            },
175
            {
176
                "Value": "Thoracic or lumbosacral neuritis or radiculitis, unspecified",
177
                "DateTime": "2009-11-01T05:00:00.000Z",
178
                "IsNegativeIndicator": false,
179
                "Codes": [
180
                    {
181
                        "Code": "M54.16",
182
                        "CodeSystem": "2.16.840.1.113883.6.90",
183
                        "CodeSystemName": "ICD-10",
184
                        "Name": "Right lumbar radiculopathy"
185
                    }
186
                ]
187
            }
188
        ]
189
    },
190
    "ChiefComplaintText": "Dark stools.",
191
    "EncountersText": "
192
Encounter	Performer	Location	Date
193
Pnuemonia	Dr Henry Seven	Community Health and Hospitals	20120806
194
",
195
    "Encounters": [
196
        {
197
            "Identifiers": [
198
                {
199
                    "ID": "2376492",
200
                    "IDType": "URMC Epic CSN"
201
                }, ...
202
            ],
203
            "Type": {
204
                "Code": "99222",
205
                "CodeSystem": "2.16.840.1.113883.6.12",
206
                "CodeSystemName": "CPT",
207
                "Name": "InPatient Admission",
208
                "AltCodes": []
209
            },
210
            "DateTime": "2012-08-06T04:00:00.000Z",
211
            "EndDateTime": null,
212
            "Providers": [ ...
213
            ],
214
            "Diagnosis": [
215
                {
216
                    "Code": "233604007",
217
                    "CodeSystem": "2.16.840.1.113883.6.96",
218
                    "CodeSystemName": "SNOMED CT",
219
                    "Name": "Pneumonia",
220
                    "AltCodes": []
221
                }
222
            ],
223
            "ReasonForVisit": [
224
                {
225
                    "Code": "233604007",
226
                    "CodeSystem": "2.16.840.1.113883.6.96",
227
                    "CodeSystemName": "SNOMED CT",
228
                    "Name": "Pneumonia",
229
                    "AltCodes": []
230
                }
231
            ]
232
        }
233
    ], 
234
    "FamilyHistoryText": "Father (deceased)
235
Diagnosis	Age At Onset
236
Myocardial Infarction (cause of death)	57
237
Diabetes	40
238
",
239
    "FamilyHistory": [ ...
240
     ],
241
    "HistoryOfPresentIllnessText": "Kelp, Lonnie Ray Sr., MD PHD - 10/21/2014 8:07 PM PSTDate: 10/21/2014
242


243
Pre-procedure diagnosis: L5 S1 Acute Lumbar Radiculopathy (Right)
244


245
Post-procedure diagnosis: Same
246


247
Procedure: 1) L5S1 Transforaminal Epidural Steroid injection(Right)
248
2) Fluoroscopic Guidance for needle placement
249


250
Complications: None
251


252
CONSENT: Today's procedure, its potential benefits as well as its risks and potential side effects were reviewed. Discussed risks of the procedure include bleeding, infection, nerve irritation or damage, reactions to the medications, headache, failure of the pain to improve, and exacerbation of the pain were explained to the patient, who verbalized understanding and who wished to proceed. Informed consent was signed.
253


254
DESCRIPTION OF PROCEDURES: After written informed consent was obtained, the patient was taken to the fluoroscopy suite. Anatomical landmarks were identified by way of fluoroscopy in multiple views. Strict aseptic technique was utilized.
255


256
A 22-gauge 3-1/2-inch needle was then incrementally advanced using multiple fluoroscopic views from an oblique approach into the Right L5S1 lumbar intervertebral space. Both AP and lateral views were used to confirm final needle placement. After negative aspiration, Omniopaque 240 contrast was injected which delineated epidural without vascular flow and a normal epidurogram under fluoroscopy in the lateral and AP view. After negative aspiration was reconfirmed, a 1.0 mL of 0.25% Bupivicaine and 1mL of 40 mg/mL of Kenalog was slowly injected into the epidural space.
257


258
All needles were removed intact. Hemostasis was maintained. There were no complications. The area was cleaned and a Band-Aid placed as necessary. The patient tolerated the procedure well and all needles were removed intact. After a period of observation, the patient was noted to be hemodynamically stable and neurovascularly intact following the procedure as prior to the procedure, and was ultimately discharged to home with supervision in good condition. The patient was instructed to schedule an appointment in the office within 2 weeks.
259
Lonnie Ray Kelp Sr., MD PHD
260


261
",
262
    "ImmunizationText": "
263
Vaccine	Date	Status
264
Influenza virus vaccine, IM	May 2012	Completed
265
Tetanus and diphtheria toxoids, IM	Apr 2012	Completed
266
",
267
    "Immunizations": [ ...
268
    ],
269
    "InstructionsText": "Please carefully follow the subsequent instructions and patient education:
270


271
FlossBrush teeth twice daily
272


273
Scarf tying instructions may be found online.",
274
    "InsurancesText": null,
275
    "Insurances": [
276
        {
277
            "Plan": { ...
278
            }
279
        }
280
    ],
281
    "InterventionsText": "Patient practiced use of novel prosthesis including movements formerly neglected including distal extension and retroflexive hyperextension.",
282
    "MedicalEquipmentText": "
283
Supply/Device	Date Supplied
284
Automatic implantable cardioverter/defibrillator	Nov 1999
285
Total hip replacement prosthesis	1998
286
Wheelchair	1999
287
",
288
    "MedicalEquipment": [ ...
289
     ],
290
    "MedicationsText": "
291
Medication	Directions	Start Date	Status	Indications	Fill Instructions
292
Albuterol 0.09 MG/ACTUAT inhalant solution	0.09 MG/ACTUAT inhalant solution, 2 puffs once	20120806	Active	Pneumonia (233604007 SNOMED CT)	Generic Substitition Allowed
293
",
294
    "Medications": [ ...
295
     ],
296
    "MedicationsAdministeredText": "
297
Medication	Start Date	Status
298
Albuterol 0.09 MG/ACTUAT inhalant solution	0.09 MG/ACTUAT inhalant solution, 2 puffs once	20120806	Active
299
",
300
    "MedicationsAdministered": [ ...
301
    ],
302
    "ObjectiveText": "Chest: clear to ausc. No rales, normal breath soundsHeart: RR, PMI in normal location and no heave or evidence ofcardiomegaly,normal heart sounds, no murm or gallop",
303
    "PhysicalExamText": "All examinations performed within normal limits.
304


305
WNL
306


307
Nothing to report here.",
308
    "PlanOfCareText": "
309
Planned Activity	Planned Date
310
Consultation with Dr George Potomac for Asthma	20120820
311
Chest X-ray	20120826
312
Sputum Culture	20120820
313
",
314
    "PlanOfCare": { ...
315
    }
316
    "ProblemsText": "Pneumonia : Status - ResolvedAsthma : Status - Active",
317
    "Problems": [ ...
318
    ],
319
    "ProceduresText": "
320
Procedure	Date
321
Chest X-Ray	8/7/2012
322
",
323
    "Procedures": { ...
324
    },
325
    "ReasonForReferralText": "
326
Incoming Referral	Reason	Specialty	Diagnoses / Procedures	Referred By Contact	Referred To Contact
327
Consult, Test & Treat (Routine)		BA-Physical Medicine / Physical Medicine and Rehab	DiagnosesRadiculopathy, lumbar regionL5S1 TTRANSFORMINAL ESIL5S1 TTRANSFORMINAL ESIProceduresPR INJECT ANES/STEROID FORAMEN LUMBAR/SACRAL W IMG GUIDE ,1 LEVELINJECTION	Kelp, Lonnie Ray Sr., MD PHD	Kelp, Lonnie Ray Sr., MD PHD
328
",
329
    "ReasonForVisitText": "Light stools.",
330
    "ResultText": "
331
LABORATORY INFORMATION
332
Chemistries and drug levels
333
HGB (M 13-18 g/dl; F 12-16 g/dl)	13.2
334
WBC (4.3-10.8 10+3/ul)	6.7
335
PLT (135-145 meq/l)	123 (L)
336
",
337
    "Results": [ ...
338
    ],
339
    "ReviewOfSystemsText": "Patient denies recent history of fever or malaise. Positive for weakness and shortness of breath. One episode of melena. No recent headaches. Positive for osteoarthritis in hips, knees and hands.",
340
    "SocialHistoryText": "
341
Social History Element	Description	Effective Dates
342
smoking	Former Smoker (1 pack per day	20050501 to 20110227
343
smoking	Current Everyday Smoker 2 packs per day	20110227 - today
344
",
345
    "SocialHistory": { ...
346
    },
347
    "SubjectiveText": " Complaints of rectal bleeding, fatigue and a change in bowel patterns. Has several days of constipation alternating with diarrhea. ",
348
    "VitalSignsText": "
349
Date / Time: 	Nov 1, 2011	August 6, 2012
350
Height	69 inches	69 inches
351
Weight	189 lbs	194 lbs
352
Blood Pressure	132/86 mmHg	145/88 mmHg
353
",
354
    "VitalSigns": [ ...
355
    ]
356
}

Manage patient consent

By default, we treat each patient as "consented" if their data is saved into a Redox repository. If a patient declines consent, however, you can send a PatientAdmin.PatientUpdate with the Consent extension (learn about extensions or review Redox extensions). You can toggle the patient’s consent status to declined by sending an empty codeableConcept with the Consent extension.

Example: Declined patient consent in Consent extension
json
1
{
2
   "url": "https://api.redoxengine.com/extensions/consent-type",
3
   "codeableConcept": []
4
}

When a patient’s consent status changes, any of their existing data in the repository will no longer be returned in query responses.

To update a patient’s consent, you must send a PatientAdmin.PatientUpdate with codeableConcept populated as it is in the example below. This text toggles a patient’s consent status again so that data can be returned in query responses.

Example: Toggle a patient’s consent with the Consent extension
json
1
{
2
   "url": "https://api.redoxengine.com/extensions/consent-type",
3
   "codeableConcept": [
4
       {
5
            "text": "Treatment",
6
            "coding": [
7
                {
8
                    "system": "2.16.840.1.113883.3.18.7.1",
9
                    "code": "TREATMENT",
10
                    "display": "Treatment"
11
                }
12
            ]
13
        },
14
        {
15
            "text": "Request of the Individual",
16
            "coding": [
17
                {
18
                    "system": "2.16.840.1.113883.3.18.7.1",
19
                    "code": "REQUEST",
20
                    "display": "Request of the Individual"
21
                }
22
            ]
23
        },
24
    ]
25
}