- Existing customers using Network Onramps
All Carequality participants—including those who join via Redox—must respond to 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. 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.
If you are your own responder, you must build an infrastructure capable of supporting a large volume of incoming requests. And you must still maintain your own patient and document database so that you can respond to incoming requests with the most accurate data.
You can copy the code examples we provide and send the test requests with curl (learn more about curl) instead of Postman. To do that, you must remove the comments from the code examples (starting with //) and replace any variables (e.g., {{variable here}}).
Some of the code examples are abbreviated, so be mindful of that if you're copying them for your own use.
As you create and update patient records in your system, you must make sure that they stay current in your data on demand repository.
If you're operating in Canada, you must tweak the Redox hostname slightly. All you need to do is add a ca in that URL like this: https://api.ca.redoxengine.com.
- For new patients, send a PatientAdmin.NewPatient request with the new patient's details to your data on demand repository. You must use at least one patient identifier with the ID Type of the patient OID assigned to you in the wizard.Example: Create a new patientbash1curl \2-X POST https://api.redoxengine.com/endpoint \3-H "Content-Type: application/json" \4-H "Authorization: Bearer {{access token from auth process}}" \5-d '{6"Meta": {7"DataModel": "PatientAdmin",8"EventType": "NewPatient",9# Remove in production10"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"Patient": {19"Identifiers": [20{21# This ID should be the MRN or primary ID of the patient in your system22# Then the "IDType" you should map from your ID type to the value Redox provides23# Typically this is mapping some value like "MR" to this OID.24# This OID is linked to the repository and required to associate the patient25"ID": "1234",26"IDType": "{{patient_oid}}"27}28],29# All the below should be set as appropriate for your organization30# including as much information as you can provide. See the API documentation31# for more information32"Demographics": {33"FirstName": "Timothy",34"MiddleName": "Paul",35"LastName": "Bixby",36"DOB": "2008-01-06",37"SSN": "101-01-0001",38"Sex": "Male",39"Race": "White",40"IsHispanic": null,41"MaritalStatus": "Married",42"IsDeceased": null,43"DeathDateTime": null,44"PhoneNumber": {45"Home": "+18088675301",46"Office": null,47"Mobile": null48},49"EmailAddresses": [],50"Language": "en",51"Citizenship": [],52"Address": {53"StreetAddress": "4762 Hickory Street",54"City": "Monroe",55"State": "WI",56"ZIP": "53566",57"County": "Green",58"Country": "US"59}60},61"Notes": [],62"Contacts": [63{64"FirstName": "Barbara",65"MiddleName": null,66"LastName": "Bixby",67"Address": {68"StreetAddress": "4762 Hickory Street",69"City": "Monroe",70"State": "WI",71"ZIP": "53566",72"County": "Green",73"Country": "US"74},75"PhoneNumber": {76"Home": "+18088675303",77"Office": "+17077543758",78"Mobile": "+19189368865"79},80"RelationToPatient": "Mother",81"EmailAddresses": [82"barb.bixby@test.net"83],84"Roles": [85"Emergency Contact"86]87}88],89"Allergies": [90{91"Code": "7982",92"Codeset": "RxNorm",93"Name": "Penicillin",94"Type": {95"Code": null,96"Codeset": null,97"Name": null98},99"OnsetDateTime": null,100"Reaction": [101{102"Code": "28926001",103"Codeset": "SNOMED CT",104"Name": "Rash"105},106{107"Code": "247472004",108"Codeset": "SNOMED CT",109"Name": "Hives"110}111],112"Severity": {113"Code": null,114"Codeset": null,115"Name": null116},117"Status": null118}119],120"PCP": {121"NPI": "4356789876",122"ID": "4356789876",123"IDType": "NPI",124"FirstName": "Pat",125"LastName": "Granite",126"Credentials": [127"MD"128],129"Address": {130"StreetAddress": "123 Main St.",131"City": "Madison",132"State": "WI",133"ZIP": "53703",134"County": "Dane",135"Country": "USA"136},137"EmailAddresses": [],138"PhoneNumber": {139"Office": "+16085551234"140},141"Location": {142"Type": null,143"Facility": null,144"Department": null,145"Room": null146}147},148"Guarantor": {149"Number": "10001910",150"FirstName": "Kent",151"MiddleName": null,152"LastName": "Bixby",153"SSN": null,154"DOB": null,155"Sex": null,156"Spouse": {157"FirstName": "Barbara",158"LastName": "Bixby"159},160"Address": {161"StreetAddress": "4762 Hickory Street",162"City": "Monroe",163"State": "WI",164"ZIP": "53566",165"County": "Green",166"Country": "USA"167},168"PhoneNumber": {169"Home": null,170"Business": null,171"Mobile": null172},173"EmailAddresses": [],174"Type": null,175"RelationToPatient": "Father",176"Employer": {177"Name": "Accelerator Labs",178"Address": {179"StreetAddress": "1456 Old Sauk Road",180"City": "Madison",181"State": "WI",182"ZIP": "53719",183"County": "Dane",184"Country": "USA"185},186"PhoneNumber": "+18083451121"187}188},189"Insurances": [190{191"Plan": {192"ID": "31572",193"IDType": "Payor ID",194"Name": "HMO Deductable Plan",195"Type": null196},197"MemberNumber": null,198"Company": {199"ID": "60054",200"IDType": null,201"Name": "aetna (60054 0131)",202"Address": {203"StreetAddress": "PO Box 14080",204"City": "Lexington",205"State": "KY",206"ZIP": "40512-4079",207"County": "Fayette",208"Country": "US"209},210"PhoneNumber": "+18089541123"211},212"GroupNumber": "847025-024-0009",213"GroupName": "Accelerator Labs",214"EffectiveDate": "2015-01-01",215"ExpirationDate": "2020-12-31",216"PolicyNumber": "9140860055",217"AgreementType": null,218"CoverageType": null,219"Insured": {220"Identifiers": [],221"LastName": null,222"MiddleName": null,223"FirstName": null,224"SSN": null,225"Relationship": null,226"DOB": null,227"Sex": null,228"Address": {229"StreetAddress": null,230"City": null,231"State": null,232"ZIP": null,233"County": null,234"Country": null235}236}237}238]239}240}API reference
Review the PatientAdmin data model schema for more technical details.
- If demographics or contact information changes for existing patients, send a PatientAdmin.PatientUpdate request with the updated details to your data on demand repository.Example: Update an existing patientbash1curl \2-X POST https://api.redoxengine.com/endpoint \3-H "Content-Type: application/json" \4-H "Authorization: Bearer {{access token from auth process}}" \5-d '{6"Meta": {7"DataModel": "PatientAdmin",8"EventType": "PatientUpdate",9# Remove in production10"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"Patient": {19"Identifiers": [20{21# This ID should be the MRN or primary ID of the patient in your system22# Then the "IDType" you should map from your ID type to the value Redox provides23# Typically this is mapping some value like "MR" to this OID.24# This OID is linked to the repository and required to associate the patient25"ID": "1234",26"IDType": "{{patient_oid}}"27}28],29# All the below should be set as appropriate for your organization30# including as much information as you can provide. See the API documentation31# for more information32"Demographics": {33"FirstName": "Timothy",34"MiddleName": "Paul",35"LastName": "Bixby",36"DOB": "2008-01-06",37"SSN": "101-01-0001",38"Sex": "Male",39"Race": "White",40"IsHispanic": null,41"MaritalStatus": "Married",42"IsDeceased": null,43"DeathDateTime": null,44"PhoneNumber": {45"Home": "+18088675301",46"Office": null,47"Mobile": null48},49"EmailAddresses": [],50"Language": "en",51"Citizenship": [],52"Address": {53"StreetAddress": "4435 Victoria Ln",54"City": "Madison",55"State": "WI",56"ZIP": "53719",57"County": "Dane",58"Country": "US"59}60},61"Notes": [],62"Contacts": [63{64"FirstName": "Barbara",65"MiddleName": null,66"LastName": "Bixby",67"Address": {68"StreetAddress": "4762 Hickory Street",69"City": "Monroe",70"State": "WI",71"ZIP": "53566",72"County": "Green",73"Country": "US"74},75"PhoneNumber": {76"Home": "+18088675303",77"Office": "+17077543758",78"Mobile": "+19189368865"79},80"RelationToPatient": "Mother",81"EmailAddresses": [82"barb.bixby@test.net"83],84"Roles": [85"Emergency Contact"86]87}88],89"Diagnoses": [90{91"Code": "R07.0",92"Codeset": "ICD-10",93"Name": "Pain in throat",94"Type": null,95"DocumentedDateTime": null96}97],98"Allergies": [99{100"Code": "7982",101"Codeset": "RxNorm",102"Name": "Penicillin",103"Type": {104"Code": null,105"Codeset": null,106"Name": null107},108"OnsetDateTime": null,109"Reaction": [110{111"Code": "28926001",112"Codeset": "SNOMED CT",113"Name": "Rash"114},115{116"Code": "247472004",117"Codeset": "SNOMED CT",118"Name": "Hives"119}120],121"Severity": {122"Code": null,123"Codeset": null,124"Name": null125},126"Status": null127}128],129"PCP": {130"NPI": "4356789876",131"ID": "4356789876",132"IDType": "NPI",133"FirstName": "Pat",134"LastName": "Granite",135"Credentials": [136"MD"137],138"Address": {139"StreetAddress": "123 Main St.",140"City": "Madison",141"State": "WI",142"ZIP": "53703",143"County": "Dane",144"Country": "USA"145},146"EmailAddresses": [],147"PhoneNumber": {148"Office": "+16085551234"149},150"Location": {151"Type": null,152"Facility": null,153"Department": null,154"Room": null155}156},157"Insurances": [158{159"Plan": {160"ID": "31572",161"IDType": "Payor ID",162"Name": "HMO Deductable Plan",163"Type": null164},165"MemberNumber": null,166"Company": {167"ID": "60054",168"IDType": null,169"Name": "aetna (60054 0131)",170"Address": {171"StreetAddress": "PO Box 14080",172"City": "Lexington",173"State": "KY",174"ZIP": "40512-4079",175"County": "Fayette",176"Country": "US"177},178"PhoneNumber": "+18089541123"179},180"GroupNumber": "847025-024-0009",181"GroupName": "Accelerator Labs",182"EffectiveDate": "2015-01-01",183"ExpirationDate": "2020-12-31",184"PolicyNumber": "9140860055",185"AgreementType": null,186"CoverageType": null,187"Insured": {188"Identifiers": [],189"LastName": null,190"MiddleName": null,191"FirstName": null,192"SSN": null,193"Relationship": null,194"DOB": null,195"Sex": null,196"Address": {197"StreetAddress": null,198"City": null,199"State": null,200"ZIP": null,201"County": null,202"Country": null203}204}205}206],207"Guarantor": {208"Number": "10001910",209"FirstName": "Kent",210"MiddleName": null,211"LastName": "Bixby",212"SSN": null,213"DOB": null,214"Sex": null,215"Spouse": {216"FirstName": "Barbara",217"LastName": "Bixby"218},219"Address": {220"StreetAddress": "4762 Hickory Street",221"City": "Monroe",222"State": "WI",223"ZIP": "53566",224"County": "Green",225"Country": "USA"226},227"PhoneNumber": {228"Home": null,229"Business": null,230"Mobile": null231},232"EmailAddresses": [],233"Type": null,234"RelationToPatient": "Father",235"Employer": {236"Name": "Accelerator Labs",237"Address": {238"StreetAddress": "1456 Old Sauk Road",239"City": "Madison",240"State": "WI",241"ZIP": "53719",242"County": "Dane",243"Country": "USA"244},245"PhoneNumber": "+18083451121"246}247}248}249}
- To combine duplicate records for one patient, send a PatientAdmin.PatientMerge request to merge the patient records in your data on demand repository and replace the previous identifiers with the new one.Example: Merge patient recordsbash1curl \2-X POST https://api.redoxengine.com/endpoint \3-H "Content-Type: application/json" \4-H "Authorization: Bearer {{access token from auth process}}" \5-d '{6"Meta": {7"DataModel": "PatientAdmin",8"EventType": "PatientMerge",9# Remove in production10"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"Patient": {19"Identifiers": [20{21# This is the new ID for the patient22"ID": "1235",23"IDType": "{{patient_oid}}"24}25],26# This will be the old ID that this patient had27"PreviousIdentifiers": [28{29"ID": "1234",30"IDType": "{{patient_oid}}"31}32],33# All the below should be set as appropriate for your organization34# including as much information as you can provide. See the API documentation35# for more information36"Demographics": {37"FirstName": "Timothy",38"MiddleName": "Paul",39"LastName": "Bixby",40"DOB": "2008-01-06",41"SSN": "101-01-0001",42"Sex": "Male",43"Race": "White",44"IsHispanic": null,45"MaritalStatus": "Married",46"IsDeceased": null,47"DeathDateTime": null,48"PhoneNumber": {49"Home": "+18088675301",50"Office": null,51"Mobile": null52},53"EmailAddresses": [],54"Language": "en",55"Citizenship": [],56"Address": {57"StreetAddress": "4762 Hickory Street",58"City": "Monroe",59"State": "WI",60"ZIP": "53566",61"County": "Green",62"Country": "US"63}64},65"Notes": []66}67}
As a Carequality participant, you must include certain data when you're returning data to the Carequality Framework. Check out the rules for returned data.
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:
FIeld | Notes |
---|---|
Header.Patient.Identifiers[].IDType | At least one patient identifier should include an ID Type that matches the patient identification OID used in the PatientAdmin messages. |
Header.Document.ID | This 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 Header.Document.TypeCode | These 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.Name | We recommend populating this value since it tells other Carequality 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.Location | Some 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 Carequality. |
Review the ClinicalSummary data model schema for more technical details.
Since ClinicalSummary.VisitPush is lengthy, we include an abbreviated example below. Check out an unabbreviated example or view the Postman package.
1curl \2-X POST https://api.redoxengine.com/endpoint \3-H "Content-Type: application/json" \4-H "Authorization: Bearer {{access token from auth process}}" \5-d '{6"Meta": {7"DataModel": "Clinical Summary",8"EventType": "VisitPush",9# Remove in production10"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# All the below should be set as appropriate for your organization.19# See the API documentation for more information.20"Header": {21"DirectAddressFrom": null,22"DirectAddressTo": null,23"Document": {24"Author": {25"ID": "4356789876",26"IDType": "NPI",27"Type": null,28"FirstName": "Pat",29"LastName": "Granite",30"Credentials": [31"MD"32],33"Address": {34"StreetAddress": "123 Main St.",35"City": "Madison",36"State": "WI",37"ZIP": "53703",38"County": "Dane",39"Country": "USA"40},41"EmailAddresses": [],42"PhoneNumber": {43"Office": "+16085551234"44},45"Location": { ...46}47},48"ID": "{{redoxDevDocumentOid}}^67890",49"Locale": "US",50"Title": "Community Health and Hospitals: Annual Physical",51"DateTime": "2012-09-12T00:00:00.000Z",52"Type": "Progress Note",53"TypeCode": {54"Code": "18842-5",55"CodeSystem": "2.16.840.1.113883.6.1",56"CodeSystemName": "LOINC",57"Name": "Progress Note"58},59"Visit": {60"Location": {61"Type": "Outpatient Clinic",62"Facility": "RHS Vista Oaks Clinic",63"Department": "Vista Oaks Clinic",64"Room": null65},66"StartDateTime": "2020-11-12T00:18:30.592Z",67"EndDateTime": "2020-11-12T00:18:30.592Z",68"Reason": "Annual Physical",69"VisitNumber": "30311442"70}71},72"Patient": {73"Identifiers": [74{75"ID": "1234",76"IDType": "{{redoxDevPatientOid}}"77}78],79"FirstName": "Timothy",80"MiddleName": "Paul",81"LastName": "Bixby",82"DOB": "2008-01-06",83"SSN": "101-01-0001",84"Sex": "Male",85"Race": "White",86"IsHispanic": null,87"MaritalStatus": "Married",88"IsDeceased": null,89"DeathDateTime": null,90"PhoneNumber": {91"Home": "+18088675301",92},93"EmailAddresses": [],94"Language": "en",95"Citizenship": [],96"Address": {97"StreetAddress": "4762 Hickory Street",98"City": "Monroe",99"State": "WI",100"ZIP": "53566",101"County": "Green",102"Country": "US"103}104},105"PCP": { ...106}107},108"AdvanceDirectivesText": "109Directive Description Verification Supporting Document(s)110Resuscitation status Do not resuscitate Dr. Robert Dolin, Nov 07, 1999 Advance directive111",112"AdvanceDirectives": [113{114"Type": {115"Code": "304251008",116"CodeSystem": "2.16.840.1.113883.6.96",117"CodeSystemName": "SNOMED CT",118"Name": "Resuscitation",119"AltCodes": []120},121"Code": "304253006",122"CodeSystem": "2.16.840.1.113883.6.96",123"CodeSystemName": "SNOMED CT",124"Name": "Do not resuscitate",125"AltCodes": [],126"StartDate": "2011-02-13T05:00:00.000Z",127"EndDate": null,128"ExternalReference": "AdvanceDirective.b50b7910-7ffb-4f4c-bbe4-177ed68cbbf3.pdf",129"VerifiedBy": [130{131"FirstName": "Robert",132"LastName": "Dolin",133"Credentials": "Dr.",134"DateTime": null135}136],137"Custodians": [138{139"FirstName": "Robert",140"LastName": "Dolin",141"Credentials": "Dr.",142"Address": { ...143}144}145]146}147],148"AllergyText": "149Substance Reaction Severity Status150Penicillin G benzathine Hives Moderate to severe Inactive151Codeine Shortness of Breath Moderate Active152Aspirin Hives Mild to moderate Active153",154"Allergies": [ ...155] ...156}157],158"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.",159"Assessment": {160"Diagnoses": [161{162"Value": "Displacement of lumbar intervertebral disc without myelopathy",163"DateTime": "2009-11-01T05:00:00.000Z",164"IsNegativeIndicator": false,165"Codes": [166{167"Code": "202708005",168"CodeSystem": "2.16.840.1.113883.6.96",169"CodeSystemName": "SNOMED-CT",170"Name": "Herniated lumbar intervertebral disc"171},172{ ...173}174]175},176{177"Value": "Thoracic or lumbosacral neuritis or radiculitis, unspecified",178"DateTime": "2009-11-01T05:00:00.000Z",179"IsNegativeIndicator": false,180"Codes": [181{182"Code": "M54.16",183"CodeSystem": "2.16.840.1.113883.6.90",184"CodeSystemName": "ICD-10",185"Name": "Right lumbar radiculopathy"186}187]188}189]190},191"ChiefComplaintText": "Dark stools.",192"EncountersText": "193Encounter Performer Location Date194Pnuemonia Dr Henry Seven Community Health and Hospitals 20120806195",196"Encounters": [197{198"Identifiers": [199{200"ID": "2376492",201"IDType": "URMC Epic CSN"202}, ...203],204"Type": {205"Code": "99222",206"CodeSystem": "2.16.840.1.113883.6.12",207"CodeSystemName": "CPT",208"Name": "InPatient Admission",209"AltCodes": []210},211"DateTime": "2012-08-06T04:00:00.000Z",212"EndDateTime": null,213"Providers": [ ...214],215"Diagnosis": [216{217"Code": "233604007",218"CodeSystem": "2.16.840.1.113883.6.96",219"CodeSystemName": "SNOMED CT",220"Name": "Pneumonia",221"AltCodes": []222}223],224"ReasonForVisit": [225{226"Code": "233604007",227"CodeSystem": "2.16.840.1.113883.6.96",228"CodeSystemName": "SNOMED CT",229"Name": "Pneumonia",230"AltCodes": []231}232]233}234],235"FamilyHistoryText": "Father (deceased)236Diagnosis Age At Onset237Myocardial Infarction (cause of death) 57238Diabetes 40239",240"FamilyHistory": [ ...241],242"HistoryOfPresentIllnessText": "Kelp, Lonnie Ray Sr., MD PHD - 10/21/2014 8:07 PM PSTDate: 10/21/2014243244Pre-procedure diagnosis: L5 S1 Acute Lumbar Radiculopathy (Right)245246Post-procedure diagnosis: Same247248Procedure: 1) L5S1 Transforaminal Epidural Steroid injection(Right)2492) Fluoroscopic Guidance for needle placement250251Complications: None252253CONSENT: 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.254255DESCRIPTION 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.256257A 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.258259All 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.260Lonnie Ray Kelp Sr., MD PHD261262",263"ImmunizationText": "264Vaccine Date Status265Influenza virus vaccine, IM May 2012 Completed266Tetanus and diphtheria toxoids, IM Apr 2012 Completed267",268"Immunizations": [ ...269],270"InstructionsText": "Please carefully follow the subsequent instructions and patient education:271272FlossBrush teeth twice daily273274Scarf tying instructions may be found online.",275"InsurancesText": null,276"Insurances": [277{278"Plan": { ...279}280}281],282"InterventionsText": "Patient practiced use of novel prosthesis including movements formerly neglected including distal extension and retroflexive hyperextension.",283"MedicalEquipmentText": "284Supply/Device Date Supplied285Automatic implantable cardioverter/defibrillator Nov 1999286Total hip replacement prosthesis 1998287Wheelchair 1999288",289"MedicalEquipment": [ ...290],291"MedicationsText": "292Medication Directions Start Date Status Indications Fill Instructions293Albuterol 0.09 MG/ACTUAT inhalant solution 0.09 MG/ACTUAT inhalant solution, 2 puffs once 20120806 Active Pneumonia (233604007 SNOMED CT) Generic Substitition Allowed294",295"Medications": [ ...296],297"MedicationsAdministeredText": "298Medication Start Date Status299Albuterol 0.09 MG/ACTUAT inhalant solution 0.09 MG/ACTUAT inhalant solution, 2 puffs once 20120806 Active300",301"MedicationsAdministered": [ ...302],303"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",304"PhysicalExamText": "All examinations performed within normal limits.305306WNL307308Nothing to report here.",309"PlanOfCareText": "310Planned Activity Planned Date311Consultation with Dr George Potomac for Asthma 20120820312Chest X-ray 20120826313Sputum Culture 20120820314",315"PlanOfCare": { ...316}317"ProblemsText": "Pneumonia : Status - ResolvedAsthma : Status - Active",318"Problems": [ ...319],320"ProceduresText": "321Procedure Date322Chest X-Ray 8/7/2012323",324"Procedures": { ...325},326"ReasonForReferralText": "327Incoming Referral Reason Specialty Diagnoses / Procedures Referred By Contact Referred To Contact328Consult, 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 PHD329",330"ReasonForVisitText": "Light stools.",331"ResultText": "332LABORATORY INFORMATION333Chemistries and drug levels334HGB (M 13-18 g/dl; F 12-16 g/dl) 13.2335WBC (4.3-10.8 10+3/ul) 6.7336PLT (135-145 meq/l) 123 (L)337",338"Results": [ ...339],340"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.",341"SocialHistoryText": "342Social History Element Description Effective Dates343smoking Former Smoker (1 pack per day 20050501 to 20110227344smoking Current Everyday Smoker 2 packs per day 20110227 - today345",346"SocialHistory": { ...347},348"SubjectiveText": " Complaints of rectal bleeding, fatigue and a change in bowel patterns. Has several days of constipation alternating with diarrhea. ",349"VitalSignsText": "350Date / Time: Nov 1, 2011 August 6, 2012351Height 69 inches 69 inches352Weight 189 lbs 194 lbs353Blood Pressure 132/86 mmHg 145/88 mmHg354",355"VitalSigns": [ ...356]357}
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.
1{2"url": "https://api.redoxengine.com/extensions/consent-type",3"codeableConcept": []4}
Review the PatientAdmin data model schema for more technical details.
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.
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}
Basic information
- Carequality test patients (contains patient data for you to use when testing)
How-to
Troubleshooting
FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.