All Carequality participants—including those who join via Redox—are required to respond to any requests they receive from other Carequality participants. In some cases, you may receive up to 200K requests per day.
With Redox as your Carequality responder, we can respond to incoming patient requests on your behalf so that you don’t need to build an infrastructure capable of supporting such a large volume. To do this, you must regularly push data to us so that we can maintain an accurate representation of your patient database and the applicable documents for each patient. You do this by maintaining your patient database and saving patient documents regularly. Check out more details below.
As you create and update patients in your system, you need to ensure that they stay current in our database. Use at least one patient identifier with the ID Type of the patient identification OID assigned to you in the wizard.
For new patients, send us a PatientAdmin.NewPatient request to create that patient in our database.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer {{access token from auth process}}" \-d '{"Meta": {"DataModel": "PatientAdmin","EventType": "NewPatient",# Remove in production"Test": true,"Destinations": [{# This is your repository destination ID (and will change for production)"ID": "{{repository_destination_id}}"}]},"Patient": {"Identifiers": [{# This ID should be the MRN or primary ID of the patient in your system# Then the "IDType" you should map from your ID type to the value Redox provides# Typically this is mapping some value like "MR" to this OID.# This OID is linked to the repository and required to associate the patient"ID": "1234","IDType": "{{patient_oid}}"}],# All the below should be set as appropriate for your organization# including as much information as you can provide. See the API documentation# for more information"Demographics": {"FirstName": "Timothy","MiddleName": "Paul","LastName": "Bixby","DOB": "2008-01-06","SSN": "101-01-0001","Sex": "Male","Race": "White","IsHispanic": null,"MaritalStatus": "Married","IsDeceased": null,"DeathDateTime": null,"PhoneNumber": {"Home": "+18088675301","Office": null,"Mobile": null},"EmailAddresses": [],"Language": "en","Citizenship": [],"Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "US"}},"Notes": [],"Contacts": [{"FirstName": "Barbara","MiddleName": null,"LastName": "Bixby","Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "US"},"PhoneNumber": {"Home": "+18088675303","Office": "+17077543758","Mobile": "+19189368865"},"RelationToPatient": "Mother","EmailAddresses": ["barb.bixby@test.net"],"Roles": ["Emergency Contact"]}],"Allergies": [{"Code": "7982","Codeset": "RxNorm","Name": "Penicillin","Type": {"Code": null,"Codeset": null,"Name": null},"OnsetDateTime": null,"Reaction": [{"Code": "28926001","Codeset": "SNOMED CT","Name": "Rash"},{"Code": "247472004","Codeset": "SNOMED CT","Name": "Hives"}],"Severity": {"Code": null,"Codeset": null,"Name": null},"Status": null}],"PCP": {"NPI": "4356789876","ID": "4356789876","IDType": "NPI","FirstName": "Pat","LastName": "Granite","Credentials": ["MD"],"Address": {"StreetAddress": "123 Main St.","City": "Madison","State": "WI","ZIP": "53703","County": "Dane","Country": "USA"},"EmailAddresses": [],"PhoneNumber": {"Office": "+16085551234"},"Location": {"Type": null,"Facility": null,"Department": null,"Room": null}},"Guarantor": {"Number": "10001910","FirstName": "Kent","MiddleName": null,"LastName": "Bixby","SSN": null,"DOB": null,"Sex": null,"Spouse": {"FirstName": "Barbara","LastName": "Bixby"},"Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "USA"},"PhoneNumber": {"Home": null,"Business": null,"Mobile": null},"EmailAddresses": [],"Type": null,"RelationToPatient": "Father","Employer": {"Name": "Accelerator Labs","Address": {"StreetAddress": "1456 Old Sauk Road","City": "Madison","State": "WI","ZIP": "53719","County": "Dane","Country": "USA"},"PhoneNumber": "+18083451121"}},"Insurances": [{"Plan": {"ID": "31572","IDType": "Payor ID","Name": "HMO Deductable Plan","Type": null},"MemberNumber": null,"Company": {"ID": "60054","IDType": null,"Name": "aetna (60054 0131)","Address": {"StreetAddress": "PO Box 14080","City": "Lexington","State": "KY","ZIP": "40512-4079","County": "Fayette","Country": "US"},"PhoneNumber": "+18089541123"},"GroupNumber": "847025-024-0009","GroupName": "Accelerator Labs","EffectiveDate": "2015-01-01","ExpirationDate": "2020-12-31","PolicyNumber": "9140860055","AgreementType": null,"CoverageType": null,"Insured": {"Identifiers": [],"LastName": null,"MiddleName": null,"FirstName": null,"SSN": null,"Relationship": null,"DOB": null,"Sex": null,"Address": {"StreetAddress": null,"City": null,"State": null,"ZIP": null,"County": null,"Country": null}}}]}}
If demographics or contact information changes for existing patients, send a PatientAdmin.PatientUpdate request to update our database.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer {{access token from auth process}}" \-d '{"Meta": {"DataModel": "PatientAdmin","EventType": "PatientUpdate",# Remove in production"Test": true,"Destinations": [{# This is your repository destination ID (and will change for production)"ID": "{{repository_destination_id}}"}]},"Patient": {"Identifiers": [{# This ID should be the MRN or primary ID of the patient in your system# Then the "IDType" you should map from your ID type to the value Redox provides# Typically this is mapping some value like "MR" to this OID.# This OID is linked to the repository and required to associate the patient"ID": "1234","IDType": "{{patient_oid}}"}],# All the below should be set as appropriate for your organization# including as much information as you can provide. See the API documentation# for more information"Demographics": {"FirstName": "Timothy","MiddleName": "Paul","LastName": "Bixby","DOB": "2008-01-06","SSN": "101-01-0001","Sex": "Male","Race": "White","IsHispanic": null,"MaritalStatus": "Married","IsDeceased": null,"DeathDateTime": null,"PhoneNumber": {"Home": "+18088675301","Office": null,"Mobile": null},"EmailAddresses": [],"Language": "en","Citizenship": [],"Address": {"StreetAddress": "4435 Victoria Ln","City": "Madison","State": "WI","ZIP": "53719","County": "Dane","Country": "US"}},"Notes": [],"Contacts": [{"FirstName": "Barbara","MiddleName": null,"LastName": "Bixby","Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "US"},"PhoneNumber": {"Home": "+18088675303","Office": "+17077543758","Mobile": "+19189368865"},"RelationToPatient": "Mother","EmailAddresses": ["barb.bixby@test.net"],"Roles": ["Emergency Contact"]}],"Diagnoses": [{"Code": "R07.0","Codeset": "ICD-10","Name": "Pain in throat","Type": null,"DocumentedDateTime": null}],"Allergies": [{"Code": "7982","Codeset": "RxNorm","Name": "Penicillin","Type": {"Code": null,"Codeset": null,"Name": null},"OnsetDateTime": null,"Reaction": [{"Code": "28926001","Codeset": "SNOMED CT","Name": "Rash"},{"Code": "247472004","Codeset": "SNOMED CT","Name": "Hives"}],"Severity": {"Code": null,"Codeset": null,"Name": null},"Status": null}],"PCP": {"NPI": "4356789876","ID": "4356789876","IDType": "NPI","FirstName": "Pat","LastName": "Granite","Credentials": ["MD"],"Address": {"StreetAddress": "123 Main St.","City": "Madison","State": "WI","ZIP": "53703","County": "Dane","Country": "USA"},"EmailAddresses": [],"PhoneNumber": {"Office": "+16085551234"},"Location": {"Type": null,"Facility": null,"Department": null,"Room": null}},"Insurances": [{"Plan": {"ID": "31572","IDType": "Payor ID","Name": "HMO Deductable Plan","Type": null},"MemberNumber": null,"Company": {"ID": "60054","IDType": null,"Name": "aetna (60054 0131)","Address": {"StreetAddress": "PO Box 14080","City": "Lexington","State": "KY","ZIP": "40512-4079","County": "Fayette","Country": "US"},"PhoneNumber": "+18089541123"},"GroupNumber": "847025-024-0009","GroupName": "Accelerator Labs","EffectiveDate": "2015-01-01","ExpirationDate": "2020-12-31","PolicyNumber": "9140860055","AgreementType": null,"CoverageType": null,"Insured": {"Identifiers": [],"LastName": null,"MiddleName": null,"FirstName": null,"SSN": null,"Relationship": null,"DOB": null,"Sex": null,"Address": {"StreetAddress": null,"City": null,"State": null,"ZIP": null,"County": null,"Country": null}}}],"Guarantor": {"Number": "10001910","FirstName": "Kent","MiddleName": null,"LastName": "Bixby","SSN": null,"DOB": null,"Sex": null,"Spouse": {"FirstName": "Barbara","LastName": "Bixby"},"Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "USA"},"PhoneNumber": {"Home": null,"Business": null,"Mobile": null},"EmailAddresses": [],"Type": null,"RelationToPatient": "Father","Employer": {"Name": "Accelerator Labs","Address": {"StreetAddress": "1456 Old Sauk Road","City": "Madison","State": "WI","ZIP": "53719","County": "Dane","Country": "USA"},"PhoneNumber": "+18083451121"}}}}
To combine records for one patient, send a PatientAdmin.PatientMerge request. This request merges the patient records in our database and replaces the previous identifiers with the new one.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer {{access token from auth process}}" \-d '{"Meta": {"DataModel": "PatientAdmin","EventType": "PatientMerge",# Remove in production"Test": true,"Destinations": [{# This is your repository destination ID (and will change for production)"ID": "{{repository_destination_id}}"}]},"Patient": {"Identifiers": [{# This is the new ID for the patient"ID": "1235","IDType": "{{patient_oid}}"}],# This will be the old ID that this patient had"PreviousIdentifiers": [{"ID": "1234","IDType": "{{patient_oid}}"}],# All the below should be set as appropriate for your organization# including as much information as you can provide. See the API documentation# for more information"Demographics": {"FirstName": "Timothy","MiddleName": "Paul","LastName": "Bixby","DOB": "2008-01-06","SSN": "101-01-0001","Sex": "Male","Race": "White","IsHispanic": null,"MaritalStatus": "Married","IsDeceased": null,"DeathDateTime": null,"PhoneNumber": {"Home": "+18088675301","Office": null,"Mobile": null},"EmailAddresses": [],"Language": "en","Citizenship": [],"Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "US"}},"Notes": []}}
As you provide care for patients, send your summary documents to us so that we respond to document requests as well. We recommend using the ClinicalSummary.VisitPush request with all the available unique clinical information that you produce.
Keep in mind the following requirements:
Header.Document.ID
must be globally unique across Carequality as either a GUID or an internally unique ID prefixed with your organizational OID. Our examples use the OID prefix.Header.Document.Type
and Header.Document.TypeCode
should be a LOINC code. In most cases, 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 the code for Progress Notes (i.e., 11506-3
) for outpatient/ambulatory visits, or discharge summary (i.e., 18842-5
) for inpatient/hospital visits.Since VisitPush is quite lengthy, we include an abbreviated example below. Check out an unabbreviated example or view the Postman package.
curl \-X POST https://api.redoxengine.com/endpoint \-H "Content-Type: application/json" \-H "Authorization: Bearer {{access token from auth process}}" \-d '{"Meta": {"DataModel": "Clinical Summary","EventType": "VisitPush",# Remove in production"Test": true,"Destinations": [{# This is your repository destination ID (and will change for production)"ID": "{{repository_destination_id}}"}]},# All the below should be set as appropriate for your organization.# See the API documentation for more information."Header": {"DirectAddressFrom": null,"DirectAddressTo": null,"Document": {"Author": {"ID": "4356789876","IDType": "NPI","Type": null,"FirstName": "Pat","LastName": "Granite","Credentials": ["MD"],"Address": {"StreetAddress": "123 Main St.","City": "Madison","State": "WI","ZIP": "53703","County": "Dane","Country": "USA"},"EmailAddresses": [],"PhoneNumber": {"Office": "+16085551234"},"Location": { ...}},"ID": "{{redoxDevDocumentOid}}^67890","Locale": "US","Title": "Community Health and Hospitals: Annual Physical","DateTime": "2012-09-12T00:00:00.000Z","Type": "Progress Note","TypeCode": {"Code": "18842-5","CodeSystem": "2.16.840.1.113883.6.1","CodeSystemName": "LOINC","Name": "Progress Note"},"Visit": {"Location": {"Type": "Outpatient Clinic","Facility": "RHS Vista Oaks Clinic","Department": "Vista Oaks Clinic","Room": null},"StartDateTime": "2020-11-12T00:18:30.592Z","EndDateTime": "2020-11-12T00:18:30.592Z","Reason": "Annual Physical","VisitNumber": "30311442"}},"Patient": {"Identifiers": [{"ID": "1234","IDType": "{{redoxDevPatientOid}}"}],"FirstName": "Timothy","MiddleName": "Paul","LastName": "Bixby","DOB": "2008-01-06","SSN": "101-01-0001","Sex": "Male","Race": "White","IsHispanic": null,"MaritalStatus": "Married","IsDeceased": null,"DeathDateTime": null,"PhoneNumber": {"Home": "+18088675301",},"EmailAddresses": [],"Language": "en","Citizenship": [],"Address": {"StreetAddress": "4762 Hickory Street","City": "Monroe","State": "WI","ZIP": "53566","County": "Green","Country": "US"}},"PCP": { ...}},"AdvanceDirectivesText": "Directive Description Verification Supporting Document(s)Resuscitation status Do not resuscitate Dr. Robert Dolin, Nov 07, 1999 Advance directive","AdvanceDirectives": [{"Type": {"Code": "304251008","CodeSystem": "2.16.840.1.113883.6.96","CodeSystemName": "SNOMED CT","Name": "Resuscitation","AltCodes": []},"Code": "304253006","CodeSystem": "2.16.840.1.113883.6.96","CodeSystemName": "SNOMED CT","Name": "Do not resuscitate","AltCodes": [],"StartDate": "2011-02-13T05:00:00.000Z","EndDate": null,"ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf","VerifiedBy": [{"FirstName": "Robert","LastName": "Dolin","Credentials": "Dr.","DateTime": null}],"Custodians": [{"FirstName": "Robert","LastName": "Dolin","Credentials": "Dr.","Address": { ...}}]}],"AllergyText": "Substance Reaction Severity StatusPenicillin G benzathine Hives Moderate to severe InactiveCodeine Shortness of Breath Moderate ActiveAspirin Hives Mild to moderate Active","Allergies": [ ...] ...}],"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.","Assessment": {"Diagnoses": [{"Value": "Displacement of lumbar intervertebral disc without myelopathy","DateTime": "2009-11-01T05:00:00.000Z","IsNegativeIndicator": false,"Codes": [{"Code": "202708005","CodeSystem": "2.16.840.1.113883.6.96","CodeSystemName": "SNOMED-CT","Name": "Herniated lumbar intervertebral disc"},{ ...}]},{"Value": "Thoracic or lumbosacral neuritis or radiculitis, unspecified","DateTime": "2009-11-01T05:00:00.000Z","IsNegativeIndicator": false,"Codes": [{"Code": "M54.16","CodeSystem": "2.16.840.1.113883.6.90","CodeSystemName": "ICD-10","Name": "Right lumbar radiculopathy"}]}]},"ChiefComplaintText": "Dark stools.","EncountersText": "Encounter Performer Location DatePnuemonia Dr Henry Seven Community Health and Hospitals 20120806","Encounters": [{"Identifiers": [{"ID": "2376492","IDType": "URMC Epic CSN"}, ...],"Type": {"Code": "99222","CodeSystem": "2.16.840.1.113883.6.12","CodeSystemName": "CPT","Name": "InPatient Admission","AltCodes": []},"DateTime": "2012-08-06T04:00:00.000Z","EndDateTime": null,"Providers": [ ...],"Diagnosis": [{"Code": "233604007","CodeSystem": "2.16.840.1.113883.6.96","CodeSystemName": "SNOMED CT","Name": "Pneumonia","AltCodes": []}],"ReasonForVisit": [{"Code": "233604007","CodeSystem": "2.16.840.1.113883.6.96","CodeSystemName": "SNOMED CT","Name": "Pneumonia","AltCodes": []}]}],"FamilyHistoryText": "Father (deceased)Diagnosis Age At OnsetMyocardial Infarction (cause of death) 57Diabetes 40","FamilyHistory": [ ...],"HistoryOfPresentIllnessText": "Kelp, Lonnie Ray Sr., MD PHD - 10/21/2014 8:07 PM PSTDate: 10/21/2014Pre-procedure diagnosis: L5 S1 Acute Lumbar Radiculopathy (Right)Post-procedure diagnosis: SameProcedure: 1) L5S1 Transforaminal Epidural Steroid injection(Right)2) Fluoroscopic Guidance for needle placementComplications: NoneCONSENT: 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.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.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.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.Lonnie Ray Kelp Sr., MD PHD","ImmunizationText": "Vaccine Date StatusInfluenza virus vaccine, IM May 2012 CompletedTetanus and diphtheria toxoids, IM Apr 2012 Completed","Immunizations": [ ...],"InstructionsText": "Please carefully follow the subsequent instructions and patient education:FlossBrush teeth twice dailyScarf tying instructions may be found online.","InsurancesText": null,"Insurances": [{"Plan": { ...}}],"InterventionsText": "Patient practiced use of novel prosthesis including movements formerly neglected including distal extension and retroflexive hyperextension.","MedicalEquipmentText": "Supply/Device Date SuppliedAutomatic implantable cardioverter/defibrillator Nov 1999Total hip replacement prosthesis 1998Wheelchair 1999","MedicalEquipment": [ ...],"MedicationsText": "Medication Directions Start Date Status Indications Fill InstructionsAlbuterol 0.09 MG/ACTUAT inhalant solution 0.09 MG/ACTUAT inhalant solution, 2 puffs once 20120806 Active Pneumonia (233604007 SNOMED CT) Generic Substitition Allowed","Medications": [ ...],"MedicationsAdministeredText": "Medication Start Date StatusAlbuterol 0.09 MG/ACTUAT inhalant solution 0.09 MG/ACTUAT inhalant solution, 2 puffs once 20120806 Active","MedicationsAdministered": [ ...],"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","PhysicalExamText": "All examinations performed within normal limits.WNLNothing to report here.","PlanOfCareText": "Planned Activity Planned DateConsultation with Dr George Potomac for Asthma 20120820Chest X-ray 20120826Sputum Culture 20120820","PlanOfCare": { ...}"ProblemsText": "Pneumonia : Status - ResolvedAsthma : Status - Active","Problems": [ ...],"ProceduresText": "Procedure DateChest X-Ray 8/7/2012","Procedures": { ...},"ReasonForReferralText": "Incoming Referral Reason Specialty Diagnoses / Procedures Referred By Contact Referred To ContactConsult, 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","ReasonForVisitText": "Light stools.","ResultText": "LABORATORY INFORMATIONChemistries and drug levelsHGB (M 13-18 g/dl; F 12-16 g/dl) 13.2WBC (4.3-10.8 10+3/ul) 6.7PLT (135-145 meq/l) 123 (L)","Results": [ ...],"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.","SocialHistoryText": "Social History Element Description Effective Datessmoking Former Smoker (1 pack per day 20050501 to 20110227smoking Current Everyday Smoker 2 packs per day 20110227 - today","SocialHistory": { ...},"SubjectiveText": " Complaints of rectal bleeding, fatigue and a change in bowel patterns. Has several days of constipation alternating with diarrhea. ","VitalSignsText": "Date / Time: Nov 1, 2011 August 6, 2012Height 69 inches 69 inchesWeight 189 lbs 194 lbsBlood Pressure 132/86 mmHg 145/88 mmHg","VitalSigns": [ ...]}