Quick Start Guide: Documenting a Visit

In this guide we will go over the steps necessary for your app to document a visit. We will also go over what this workflow will enable your application to do and how you’ll need to configure your application to support it.

Prior to getting started, you’ll want to:

What is Documenting a Visit?

Documenting a visit is the action of sending data into a healthcare organization’s EHR to have it associated with a specific visit a patient is having. The documentation comes from your app in the form of a Media, Note, or Unsolicited Result message and is associated with a Visit that a patient has. In broad terms then, this means your app must be capable of two things:

  1. Receiving and persisting Scheduling data from a healthcare organization to know when where and for whom a Visit is occurring.
  2. Sending a Media, Note, or Unsolicited Result message that encapsulates the data you wish to incorporate into the Visit.

Receiving Scheduling Data

To receive Scheduling data from a healthcare organization using Redox, you’ll need to have and endpoint for your application set up as a Destination. Your destination should be able to receive and handle JSON in our Scheduling data model. Below is an example of the sort of message you will be receiving. You test sending data to your Destination using DevTools in your Redox Dashboard.

{
  "Meta": {
      "DataModel": "Scheduling",
      "EventType": "New",
      "EventDateTime": "2020-11-05T19:32:15.691Z",
      "Test": true,
      "Source": {
        "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
        "Name": "Redox Dev Tools"
      },
      "Destinations": [
        {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
        }
      ],
      "Message": {
        "ID": 5565
      },
      "Transmission": {
        "ID": 12414
      },
      "FacilityCode": null
  },
  "Patient": {
      "Identifiers": [
        {
            "ID": "0000000001",
            "IDType": "MR"
        },
        {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
        },
        {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
        }
      ],
      "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": []
  },
  "AppointmentInfo": [
      {
        "Code": "23457",
        "Codeset": "Redox EHR Codes",
        "Description": "Priority",
        "Value": "Normal"
      },
      {
        "Code": "23457",
        "Codeset": "Redox EHR Codes",
        "Description": "Form",
        "Value": "Lumbar"
      }
  ],
  "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": "2020-11-05T19:32:16.797Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "Type": null,
      "Instructions": [],
      "AttendingProvider": {
        "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
        }
      },
      "ConsultingProvider": {
        "ID": null,
        "IDType": null,
        "FirstName": null,
        "LastName": null,
        "Credentials": [],
        "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
        },
        "EmailAddresses": [],
        "PhoneNumber": {
            "Office": null
        },
        "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
        }
      },
      "ReferringProvider": {
        "ID": null,
        "IDType": null,
        "FirstName": null,
        "LastName": null,
        "Credentials": [],
        "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
        },
        "EmailAddresses": [],
        "PhoneNumber": {
            "Office": null
        },
        "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
        }
      },
      "VisitProvider": {
        "ID": null,
        "IDType": null,
        "FirstName": null,
        "LastName": null,
        "Credentials": [],
        "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
        },
        "EmailAddresses": [],
        "PhoneNumber": {
            "Office": null
        },
        "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
        }
      },
      "Location": {
        "Type": "Inpatient",
        "Facility": "RES General Hospital",
        "Department": "3N",
        "Room": "136"
      },
      "AdditionalStaff": [],
      "Diagnoses": [
        {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null,
            "DocumentedDateTime": null
        }
      ],
      "Equipment": []
  }
}

These messages will relay to you the what, when, and for whom of a given visit. This will give your application the information it needs for associating your information with a specific patient’s visit when you send them your data.

Sending Your Documentation

In order to exercise the second half of this workflow – sending data to associate with a given visit, you must also setup your application to implement a Redox Source. This will be the gateway through which you push out the data to associate with the patient’s visit. As an authenticated Redox source, your application will then be able to send data back to the healthcare organization. Depending on the type of data your application is providing, this can be in the form of a Media, Note, or Unsolicited Result data model. The following is an example of an Unsolicited Result message that your app could send to the healthcare organization via the Redox API.

 curl \
 -X POST https://api.redoxengine.com/endpoint \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer {{access token from auth process}}" \
 -d '{
   "Meta": {
       "DataModel": "Results",
       "EventType": "NewUnsolicited",
       "EventDateTime": "2020-11-05T19:32:15.691Z",
       "Test": true,
       "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
       },
       "Destinations": [
         {
             "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
             "Name": "Redox EMR"
         }
       ],
       "Message": {
         "ID": 5565
       },
       "Transmission": {
         "ID": 12414
       },
       "FacilityCode": null
   },
   "Patient": {
       "Identifiers": [
         {
             "ID": "0000000001",
             "IDType": "MR"
         },
         {
             "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
             "IDType": "EHRID"
         },
         {
             "ID": "a1d4ee8aba494ca",
             "IDType": "NIST"
         }
       ],
       "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": [
               "[email protected]"
             ],
             "Roles": [
               "Emergency Contact"
             ]
         }
       ]
   },
   "Orders": [
       {
         "ID": null,
         "ApplicationOrderID": "1234",
         "TransactionDateTime": "2015-05-06T06:00:58.872Z",
         "CollectionDateTime": "2015-05-06T06:00:58.872Z",
         "CompletionDateTime": "2015-05-06T06:00:58.872Z",
         "Notes": [],
         "ResultsStatus": "Final",
         "Procedure": {
             "Code": "49086-2",
             "Codeset": null,
             "Description": "First trimester maternal screen with nuchal translucency panel"
         },
         "Provider": {
             "NPI": "4356789876",
             "ID": null,
             "IDType": null,
             "FirstName": "Pat",
             "LastName": "Granite",
             "Credentials": [],
             "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
             },
             "EmailAddresses": [],
             "PhoneNumber": {
               "Office": null
             },
             "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
             }
         },
         "ResultCopyProviders": [],
         "Status": "Resulted",
         "ResponseFlag": "Associated Segments",
         "Priority": "Stat",
         "Results": [
             {
               "Code": "TEST0001",
               "Codeset": null,
               "Description": "Cystic Fibrosis",
               "RelatedGroupID": null,
               "Specimen": {
                   "Source": null,
                   "BodySite": null,
                   "ID": null
               },
               "Value": "Positive Result",
               "ValueType": "String",
               "CompletionDateTime": null,
               "FileType": null,
               "Units": null,
               "Notes": [
                   "This individual is a carrier for Cystic Fibrosis."
               ],
               "AbnormalFlag": "Very Abnormal",
               "Status": "Final",
               "PrimaryResultsInterpreter": {
                   "NPI": null,
                   "ID": null,
                   "IDType": null,
                   "FirstName": null,
                   "LastName": null,
                   "Credentials": [],
                   "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                   },
                   "EmailAddresses": [],
                   "PhoneNumber": {
                     "Office": null
                   },
                   "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                   }
               },
               "Producer": {
                   "ID": "RL001",
                   "Name": "Redox Lab WI",
                   "IDType": null,
                   "Address": {
                     "StreetAddress": "111 W. Fairchild",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                   }
               },
               "Performer": {
                   "ID": null,
                   "IDType": null,
                   "FirstName": "Bob",
                   "LastName": "Smith",
                   "Credentials": [
                     "MD"
                   ],
                   "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                   },
                   "EmailAddresses": [],
                   "PhoneNumber": {
                     "Office": null
                   },
                   "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                   }
               },
               "ReferenceRange": {
                   "Low": null,
                   "High": null,
                   "Text": null
               },
               "ObservationMethod": {
                   "Code": null,
                   "Codeset": null,
                   "Description": null
               }
             },
             {
               "Code": "TEST0004",
               "Codeset": null,
               "Description": "Primary Carnitine Deficiency",
               "RelatedGroupID": null,
               "Specimen": {
                   "Source": null,
                   "BodySite": null,
                   "ID": null
               },
               "Value": "Negative Result",
               "ValueType": "String",
               "CompletionDateTime": null,
               "FileType": null,
               "Units": null,
               "Notes": [],
               "AbnormalFlag": "Normal",
               "Status": "Final",
               "PrimaryResultsInterpreter": {
                   "NPI": null,
                   "ID": null,
                   "IDType": null,
                   "FirstName": null,
                   "LastName": null,
                   "Credentials": [],
                   "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                   },
                   "EmailAddresses": [],
                   "PhoneNumber": {
                     "Office": null
                   },
                   "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                   }
               },
               "Producer": {
                   "ID": "RL001",
                   "Name": "Redox Lab WI",
                   "IDType": null,
                   "Address": {
                     "StreetAddress": "111 W. Fairchild",
                     "City": "Madison",
                     "State": "WI",
                     "ZIP": "53703",
                     "County": "Dane",
                     "Country": "USA"
                   }
               },
               "Performer": {
                   "ID": null,
                   "IDType": null,
                   "FirstName": "Bob",
                   "LastName": "Smith",
                   "Credentials": [
                     "MD"
                   ],
                   "Address": {
                     "StreetAddress": null,
                     "City": null,
                     "State": null,
                     "ZIP": null,
                     "County": null,
                     "Country": null
                   },
                   "EmailAddresses": [],
                   "PhoneNumber": {
                     "Office": null
                   },
                   "Location": {
                     "Type": null,
                     "Facility": null,
                     "Department": null,
                     "Room": null
                   }
               },
               "ReferenceRange": {
                   "Low": null,
                   "High": null,
                   "Text": null
               },
               "ObservationMethod": {
                   "Code": null,
                   "Codeset": null,
                   "Description": null
               }
             }
         ]
       }
   ],
   "Visit": {
       "VisitDateTime": null,
       "VisitNumber": null,
       "AccountNumber": null,
       "PatientClass": null,
       "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null,
         "Bed": null
       },
       "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
             "StreetAddress": null,
             "City": null,
             "State": null,
             "ZIP": null,
             "County": null,
             "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
             "Office": null
         },
         "Location": {
             "Type": null,
             "Facility": null,
             "Department": null,
             "Room": null
         }
       },
       "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
             "StreetAddress": null,
             "City": null,
             "State": null,
             "ZIP": null,
             "County": null,
             "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
             "Office": null
         },
         "Location": {
             "Type": null,
             "Facility": null,
             "Department": null,
             "Room": null
         }
       }
   }
 }'

Wrapping Up

In this guide, we’ve walked through example messages for each step required to receive scheduling information from a healthcare organization and send back visit documentation.

Sign in with your Redox account to access our custom Postman collection, DevTools, and other helpful options to test this workflow out for yourself!