Medications
The Medications data model allows real-time notification of new prescriptions and modifications or cancellations to existing ones, as well as medication administrations.
Keep in mind that medication data tends to vary quite a bit across healthcare organizations. We do what we can to normalize these differences for you, but you may see that one healthcare organization provides more or less details than another. We recommend being flexible with these differences and doing extensive testing during implementation to verify that you don't have any issues with the varying levels of medication data.
We don't currently support these event types: a) Dispense: Triggered as medication is dispensed or prescriptions are filled; b) Statement: Triggered when patients self-report medications they take; c) Renewal: Triggered when a patient requests a fill of a prescription. If you have use cases for these event types, talk to your Redox rep.
If you're looking for a list of a patient's current medications, check out the ClinicalSummary data model.
Indicates a new request for a medication to be dispensed for the given patient. This event type is usually triggered by a new prescription in the outpatient context or pharmacy verification of a new order in the inpatient context.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedications
Meta.EventType
String
ReliableRequiredNew
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Allergies[]
Array of Objects
Probable
Patient.Allergies[].Code
String
ProbableA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Patient.Allergies[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Name
String
ProbableName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].Code
String
PossibleA code describing the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].Name
String
PossibleName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].Substance.Code
String
Probable
Patient.Allergies[].Substance.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.Name
String
ProbableName of the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].Code
String
PossibleA code describing the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].Name
String
PossibleName of the substance that causes the allergy/intolerance
Patient.Allergies[].Reaction[]
String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Patient.Allergies[].Reaction[].Code
String
ProbableA code describing the reaction caused by the allergy (dizziness, hives, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Name
String
ProbableName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].Code
String
PossibleA code describing the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].Name
String
PossibleName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.)
Patient.Allergies[].Reaction[].Text
String
ProbableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Patient.Allergies[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
Patient.Allergies[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Criticality.Code
String
ProbableA code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
SNOMED CT. Note this is a different concept than reaction severity.
Patient.Allergies[].Criticality.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.Name
String
ProbableName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Patient.Allergies[].Status.Code
String
ProbableA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Patient.Allergies[].Status.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.Name
String
ProbableName of the current status of the allergy (active, historic, etc.)
Patient.Allergies[].StartDate
String
ProbableWhen the allergy was first noted.
ISO 8601 Format
Patient.Allergies[].EndDate
String
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Patient.Allergies[].Comment
String
ProbableFree text comment about the allergy.
Visit
Visit
Object
PossibleThe visit that relates to this medication.
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
PossibleLocation of the visit
Visit.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location.Bed
String
PossibleBed.
Example: B
Visit.AttendingProvider.ID
String
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient that should be used for the medication.
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].Priority
String
PossibleValueSetThe insurance priority sequence.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order
Order.ID
String
ReliableRequiredID assigned by the ordering system
Order.Notes[]
Array of Strings
PossibleOrder-level notes
Order.Medication.Dose.Quantity
Numeric
ProbableThe size of the dose for pills, capsules, etc.
Order.Medication.Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Rate.Quantity
Numeric
ProbableIf the medication is in liquid form, the rate at which it is administered
Order.Medication.Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Order.Medication.Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Order.Medication.Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.Name
String
ProbableName of the method by which the medication is delivered
Order.Medication.Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Order.Medication.Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Order.Medication.Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Order.Medication.Components[]
Array of Objects
ReliableThe components of the medication
Order.Medication.Components[].Code
String
PossibleA code describing the components of the medication
Order.Medication.Components[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].Name
String
PossibleName of the components of the medication
Order.Medication.Components[].Type
String
ProbableThe type of component.
Allowed values are Base or Additive
Order.Medication.Components[].Dose.Quantity
Numeric
ProbableThe size of the dose for the component.
Order.Medication.Components[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Product.Code
String
ReliableRequiredA code describing the actual medication given.
Redox recommends using RxNorm
Order.Medication.Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.Name
String
ReliableName of the actual medication given
Order.Medication.Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Order.Medication.Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Order.Medication.Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].Name
String
PossibleName of the actual medication given
Order.Medication.FreeTextSig
String
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Order.Medication.StartDate
String
ReliableWhen the medication should be started.
ISO 8601 Format
Order.Medication.EndDate
String
ProbableWhen the medication should be ended.
ISO 8601 Format
Order.Medication.Frequency.Period
Numeric
ProbableHow often the patient should be taking the medication
Order.Medication.Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication.
UCUM Units of Measure
Order.Medication.IsPRN
Boolean
ProbableWhether the medication is to be taken on an as-needed basis
Order.Medication.Dispense.Amount
Numeric
ProbableThe amount to be dispensed
Order.Medication.Dispense.Units
String
ProbableUnits for the dispensed amount
Order.Medication.NumberOfRefillsRemaining
Numeric
ProbableThe number of authorized refills remaining on the prescription
Order.Indications[]
Array of Objects
ProbableThis field identifies the condition or problem for which the drug/treatment was prescribed.
Order.Indications[].Code
String
ProbableCode
Order.Indications[].Codeset
String
ProbableCode set
Order.Indications[].Description
String
ProbableDescription
Order.Provider.NPI
String
PossibleNPI of the Ordering provider who is licensed to prescribe medications.
Order.Provider.ID
String
PossibleID of the Ordering provider who is licensed to prescribe medications.
This ID is often required for Inpatient Visits.
Order.Provider.IDType
String
PossibleID type of the ID for the Ordering provider who is licensed to prescribe medications.
Order.Provider.FirstName
String
PossibleFirst name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.LastName
String
PossibleLast name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Ordering provider who is licensed to prescribe medications.
e.g. MD, PhD
Order.Provider.Address
Object
PossibleProvider's address
Order.Provider.Address.StreetAddress
String
PossibleStreet address
Order.Provider.Address.City
String
PossibleCity
Order.Provider.Address.State
String
PossibleState
Order.Provider.Address.ZIP
String
PossibleZIP
Order.Provider.Address.County
String
PossibleCounty
Order.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.Provider.Location
Object
PossibleProvider's location
Order.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Department
String
PossibleDepartment
Order.Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Room
String
PossibleRoom.
Example: 136
Order.EnteredBy.ID
String
PossibleID of the The provider who actually entered the order.
This ID is often required for Inpatient Visits.
Order.EnteredBy.IDType
String
PossibleID type of the ID for the The provider who actually entered the order.
Order.EnteredBy.FirstName
String
PossibleFirst name of the The provider who actually entered the order.
Order.EnteredBy.LastName
String
PossibleLast name of the The provider who actually entered the order.
Order.EnteredBy.Credentials[]
Array of Strings
PossibleList of credentials for the The provider who actually entered the order.
e.g. MD, PhD
Order.EnteredBy.Address
Object
PossibleProvider's address
Order.EnteredBy.Address.StreetAddress
String
PossibleStreet address
Order.EnteredBy.Address.City
String
PossibleCity
Order.EnteredBy.Address.State
String
PossibleState
Order.EnteredBy.Address.ZIP
String
PossibleZIP
Order.EnteredBy.Address.County
String
PossibleCounty
Order.EnteredBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.EnteredBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.EnteredBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.EnteredBy.Location
Object
PossibleProvider's location
Order.EnteredBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.EnteredBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.EnteredBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Department
String
PossibleDepartment
Order.EnteredBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Room
String
PossibleRoom.
Example: 136
Order.VerifiedBy.ID
String
PossibleID of the The pharmacist who verified the order.
This ID is often required for Inpatient Visits.
Order.VerifiedBy.IDType
String
PossibleID type of the ID for the The pharmacist who verified the order.
Order.VerifiedBy.FirstName
String
PossibleFirst name of the The pharmacist who verified the order.
Order.VerifiedBy.LastName
String
PossibleLast name of the The pharmacist who verified the order.
Order.VerifiedBy.Credentials[]
Array of Strings
PossibleList of credentials for the The pharmacist who verified the order.
e.g. MD, PhD
Order.VerifiedBy.Address
Object
PossibleProvider's address
Order.VerifiedBy.Address.StreetAddress
String
PossibleStreet address
Order.VerifiedBy.Address.City
String
PossibleCity
Order.VerifiedBy.Address.State
String
PossibleState
Order.VerifiedBy.Address.ZIP
String
PossibleZIP
Order.VerifiedBy.Address.County
String
PossibleCounty
Order.VerifiedBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.VerifiedBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.VerifiedBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.VerifiedBy.Location
Object
PossibleProvider's location
Order.VerifiedBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.VerifiedBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.VerifiedBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Department
String
PossibleDepartment
Order.VerifiedBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Room
String
PossibleRoom.
Example: 136
Order.Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy
Object
ProbableThe pharmacy at which the medication should be dispensed.
Order.Pharmacy.Code
String
ProbableCode for the pharmacy
Order.Pharmacy.Codeset
String
ProbableCode set used to identify the pharmacy
Order.Pharmacy.Description
String
ProbableDescription of the pharmacy
Order.Pharmacy.Address
Object
ProbableThe physical location at which the medication should be dispensed.
Order.Pharmacy.Address.StreetAddress
String
ProbableStreet address
Order.Pharmacy.Address.City
String
ProbableCity
Order.Pharmacy.Address.State
String
ProbableState
Order.Pharmacy.Address.ZIP
String
ProbableZIP
Order.Pharmacy.Address.County
String
PossibleCounty
Order.Pharmacy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy.PhoneNumber.Office
String
PossiblePharmacy's office phone number.
In E. 164 Format. (e.g. +16085551234)
{
"Meta": {
"DataModel": "Medications",
"EventType": "New",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"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,
"Religion": null,
"MaritalStatus": "Single",
"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": [],
"Allergies": [
{
"Code": "7982",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Penicillin",
"AltCodes": [],
"Substance": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
}
],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Criticality": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Status": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
]
},
"Visit": {
"VisitDateTime": "2023-05-23T13:49:48.938Z",
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Insurances": []
},
"Order": {
"ID": "7f6913a7-56b6-4d2a-bb76-c0b4389d6180",
"Notes": [],
"Medication": {
"Dose": {
"Quantity": 4,
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"Components": [],
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": []
},
"FreeTextSig": null,
"StartDate": "2023-05-23T13:49:48.033Z",
"EndDate": null,
"Frequency": {
"Period": 8,
"Unit": "h"
},
"IsPRN": null,
"Dispense": {
"Amount": null,
"Units": null
},
"NumberOfRefillsRemaining": null
},
"Indications": [],
"Provider": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"EnteredBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VerifiedBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Priority": null,
"Pharmacy": {
"Code": "1234567",
"Codeset": "NCPDP",
"Description": "Fake Pharmacy",
"Address": {
"StreetAddress": "123 Fake Street",
"City": "Madison",
"State": "WI",
"ZIP": 53703,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
}
}
}
}
Indicates an updated request for medication to be dispensed for the given patient. This event type is usually triggered when some part of a medication order is changed by the ordering system.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedications
Meta.EventType
String
ReliableRequiredUpdate
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Allergies[]
Array of Objects
Probable
Patient.Allergies[].Code
String
ProbableA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Patient.Allergies[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Name
String
ProbableName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].Code
String
PossibleA code describing the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].Name
String
PossibleName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].Substance.Code
String
Probable
Patient.Allergies[].Substance.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.Name
String
ProbableName of the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].Code
String
PossibleA code describing the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].Name
String
PossibleName of the substance that causes the allergy/intolerance
Patient.Allergies[].Reaction[]
String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Patient.Allergies[].Reaction[].Code
String
ProbableA code describing the reaction caused by the allergy (dizziness, hives, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Name
String
ProbableName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].Code
String
PossibleA code describing the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].Name
String
PossibleName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.)
Patient.Allergies[].Reaction[].Text
String
ProbableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Patient.Allergies[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
Patient.Allergies[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Criticality.Code
String
ProbableA code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
SNOMED CT. Note this is a different concept than reaction severity.
Patient.Allergies[].Criticality.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.Name
String
ProbableName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Patient.Allergies[].Status.Code
String
ProbableA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Patient.Allergies[].Status.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.Name
String
ProbableName of the current status of the allergy (active, historic, etc.)
Patient.Allergies[].StartDate
String
ProbableWhen the allergy was first noted.
ISO 8601 Format
Patient.Allergies[].EndDate
String
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Patient.Allergies[].Comment
String
ProbableFree text comment about the allergy.
Visit
Visit
Object
PossibleThe visit that relates to this medication.
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
PossibleLocation of the visit
Visit.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location.Bed
String
PossibleBed.
Example: B
Visit.AttendingProvider.ID
String
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient that should be used for the medication.
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].Priority
String
PossibleValueSetThe insurance priority sequence.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order
Order.ID
String
ReliableRequiredID assigned by the ordering system
Order.Notes[]
Array of Strings
PossibleOrder-level notes
Order.Medication.Dose.Quantity
Numeric
ProbableThe size of the dose for pills, capsules, etc.
Order.Medication.Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Rate.Quantity
Numeric
ProbableIf the medication is in liquid form, the rate at which it is administered
Order.Medication.Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Order.Medication.Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Order.Medication.Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.Name
String
ProbableName of the method by which the medication is delivered
Order.Medication.Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Order.Medication.Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Order.Medication.Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Order.Medication.Components[]
Array of Objects
ReliableThe components of the medication
Order.Medication.Components[].Code
String
PossibleA code describing the components of the medication
Order.Medication.Components[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].Name
String
PossibleName of the components of the medication
Order.Medication.Components[].Type
String
ProbableThe type of component.
Allowed values are Base or Additive
Order.Medication.Components[].Dose.Quantity
Numeric
ProbableThe size of the dose for the component.
Order.Medication.Components[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Product.Code
String
ReliableRequiredA code describing the actual medication given.
Redox recommends using RxNorm
Order.Medication.Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.Name
String
ReliableName of the actual medication given
Order.Medication.Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Order.Medication.Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Order.Medication.Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].Name
String
PossibleName of the actual medication given
Order.Medication.FreeTextSig
String
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Order.Medication.StartDate
String
ReliableWhen the medication should be started.
ISO 8601 Format
Order.Medication.EndDate
String
ProbableWhen the medication should be ended.
ISO 8601 Format
Order.Medication.Frequency.Period
Numeric
ProbableHow often the patient should be taking the medication
Order.Medication.Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication.
UCUM Units of Measure
Order.Medication.IsPRN
Boolean
ProbableWhether the medication is to be taken on an as-needed basis
Order.Medication.Dispense.Amount
Numeric
ProbableThe amount to be dispensed
Order.Medication.Dispense.Units
String
ProbableUnits for the dispensed amount
Order.Medication.NumberOfRefillsRemaining
Numeric
ProbableThe number of authorized refills remaining on the prescription
Order.Indications[]
Array of Objects
ProbableThis field identifies the condition or problem for which the drug/treatment was prescribed.
Order.Indications[].Code
String
ProbableCode
Order.Indications[].Codeset
String
ProbableCode set
Order.Indications[].Description
String
ProbableDescription
Order.Provider.NPI
String
PossibleNPI of the Ordering provider who is licensed to prescribe medications.
Order.Provider.ID
String
PossibleID of the Ordering provider who is licensed to prescribe medications.
This ID is often required for Inpatient Visits.
Order.Provider.IDType
String
PossibleID type of the ID for the Ordering provider who is licensed to prescribe medications.
Order.Provider.FirstName
String
PossibleFirst name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.LastName
String
PossibleLast name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Ordering provider who is licensed to prescribe medications.
e.g. MD, PhD
Order.Provider.Address
Object
PossibleProvider's address
Order.Provider.Address.StreetAddress
String
PossibleStreet address
Order.Provider.Address.City
String
PossibleCity
Order.Provider.Address.State
String
PossibleState
Order.Provider.Address.ZIP
String
PossibleZIP
Order.Provider.Address.County
String
PossibleCounty
Order.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.Provider.Location
Object
PossibleProvider's location
Order.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Department
String
PossibleDepartment
Order.Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Room
String
PossibleRoom.
Example: 136
Order.EnteredBy.ID
String
PossibleID of the The provider who actually entered the order.
This ID is often required for Inpatient Visits.
Order.EnteredBy.IDType
String
PossibleID type of the ID for the The provider who actually entered the order.
Order.EnteredBy.FirstName
String
PossibleFirst name of the The provider who actually entered the order.
Order.EnteredBy.LastName
String
PossibleLast name of the The provider who actually entered the order.
Order.EnteredBy.Credentials[]
Array of Strings
PossibleList of credentials for the The provider who actually entered the order.
e.g. MD, PhD
Order.EnteredBy.Address
Object
PossibleProvider's address
Order.EnteredBy.Address.StreetAddress
String
PossibleStreet address
Order.EnteredBy.Address.City
String
PossibleCity
Order.EnteredBy.Address.State
String
PossibleState
Order.EnteredBy.Address.ZIP
String
PossibleZIP
Order.EnteredBy.Address.County
String
PossibleCounty
Order.EnteredBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.EnteredBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.EnteredBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.EnteredBy.Location
Object
PossibleProvider's location
Order.EnteredBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.EnteredBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.EnteredBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Department
String
PossibleDepartment
Order.EnteredBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Room
String
PossibleRoom.
Example: 136
Order.VerifiedBy.ID
String
PossibleID of the The pharmacist who verified the order.
This ID is often required for Inpatient Visits.
Order.VerifiedBy.IDType
String
PossibleID type of the ID for the The pharmacist who verified the order.
Order.VerifiedBy.FirstName
String
PossibleFirst name of the The pharmacist who verified the order.
Order.VerifiedBy.LastName
String
PossibleLast name of the The pharmacist who verified the order.
Order.VerifiedBy.Credentials[]
Array of Strings
PossibleList of credentials for the The pharmacist who verified the order.
e.g. MD, PhD
Order.VerifiedBy.Address
Object
PossibleProvider's address
Order.VerifiedBy.Address.StreetAddress
String
PossibleStreet address
Order.VerifiedBy.Address.City
String
PossibleCity
Order.VerifiedBy.Address.State
String
PossibleState
Order.VerifiedBy.Address.ZIP
String
PossibleZIP
Order.VerifiedBy.Address.County
String
PossibleCounty
Order.VerifiedBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.VerifiedBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.VerifiedBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.VerifiedBy.Location
Object
PossibleProvider's location
Order.VerifiedBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.VerifiedBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.VerifiedBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Department
String
PossibleDepartment
Order.VerifiedBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Room
String
PossibleRoom.
Example: 136
Order.Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy
Object
ProbableThe pharmacy at which the medication should be dispensed.
Order.Pharmacy.Code
String
ProbableCode for the pharmacy
Order.Pharmacy.Codeset
String
ProbableCode set used to identify the pharmacy
Order.Pharmacy.Description
String
ProbableDescription of the pharmacy
Order.Pharmacy.Address
Object
ProbableThe physical location at which the medication should be dispensed.
Order.Pharmacy.Address.StreetAddress
String
ProbableStreet address
Order.Pharmacy.Address.City
String
ProbableCity
Order.Pharmacy.Address.State
String
ProbableState
Order.Pharmacy.Address.ZIP
String
ProbableZIP
Order.Pharmacy.Address.County
String
PossibleCounty
Order.Pharmacy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy.PhoneNumber.Office
String
PossiblePharmacy's office phone number.
In E. 164 Format. (e.g. +16085551234)
{
"Meta": {
"DataModel": "Medications",
"EventType": "Update",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"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,
"Religion": null,
"MaritalStatus": "Single",
"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": [],
"Allergies": [
{
"Code": "7982",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Penicillin",
"AltCodes": [],
"Substance": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
}
],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Criticality": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Status": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
]
},
"Visit": {
"VisitDateTime": "2023-05-23T13:49:48.947Z",
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Insurances": []
},
"Order": {
"ID": "f310560d-5912-42ae-9f22-b080b69ffb05",
"Notes": [],
"Medication": {
"Dose": {
"Quantity": 4,
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"Components": [],
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": []
},
"FreeTextSig": null,
"StartDate": "2023-05-23T13:49:48.033Z",
"EndDate": null,
"Frequency": {
"Period": 8,
"Unit": "h"
},
"IsPRN": null,
"Dispense": {
"Amount": null,
"Units": null
},
"NumberOfRefillsRemaining": null
},
"Indications": [],
"Provider": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"EnteredBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VerifiedBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Priority": null,
"Pharmacy": {
"Code": "1234567",
"Codeset": "NCPDP",
"Description": "Fake Pharmacy",
"Address": {
"StreetAddress": "123 Fake Street",
"City": "Madison",
"State": "WI",
"ZIP": 53703,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
}
}
}
}
Indicates that a previous medication request has been cancelled by the ordering system.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedications
Meta.EventType
String
ReliableRequiredCancel
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Allergies[]
Array of Objects
Probable
Patient.Allergies[].Code
String
ProbableA code describing the type of allergy intolerance this is (food, drug, etc.).
SNOMED CT from Allergy/Adverse Event Type Value Set
Patient.Allergies[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Name
String
ProbableName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].Code
String
PossibleA code describing the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].AltCodes[].Name
String
PossibleName of the type of allergy intolerance this is (food, drug, etc.)
Patient.Allergies[].Substance.Code
String
Probable
Patient.Allergies[].Substance.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.Name
String
ProbableName of the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].Code
String
PossibleA code describing the substance that causes the allergy/intolerance
Patient.Allergies[].Substance.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Substance.AltCodes[].Name
String
PossibleName of the substance that causes the allergy/intolerance
Patient.Allergies[].Reaction[]
String
ProbableAll the reactions caused by this particular substance.
SNOMED CT
Patient.Allergies[].Reaction[].Code
String
ProbableA code describing the reaction caused by the allergy (dizziness, hives, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Name
String
ProbableName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].Code
String
PossibleA code describing the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].AltCodes[].Name
String
PossibleName of the reaction caused by the allergy (dizziness, hives, etc.)
Patient.Allergies[].Reaction[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT
Patient.Allergies[].Reaction[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Reaction[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.)
Patient.Allergies[].Reaction[].Text
String
ProbableFree text form of reactions to this substance, includes information that cannot be captured by coded value.
Patient.Allergies[].Severity.Code
String
ProbableA code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
Patient.Allergies[].Severity.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Severity.Name
String
ProbableName of a code for the severity of the reaction (moderate, severe, etc.).
Patient.Allergies[].Criticality.Code
String
ProbableA code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
SNOMED CT. Note this is a different concept than reaction severity.
Patient.Allergies[].Criticality.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Criticality.Name
String
ProbableName of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
Patient.Allergies[].Status.Code
String
ProbableA code describing the current status of the allergy (active, historic, etc.).
SNOMED CT (Active, Inactive, Resolved)
Patient.Allergies[].Status.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Patient.Allergies[].Status.Name
String
ProbableName of the current status of the allergy (active, historic, etc.)
Patient.Allergies[].StartDate
String
ProbableWhen the allergy was first noted.
ISO 8601 Format
Patient.Allergies[].EndDate
String
ProbableWhen the allergy was no longer a problem (if applicable).
ISO 8601 Format
Patient.Allergies[].Comment
String
ProbableFree text comment about the allergy.
Visit
Visit
Object
PossibleThe visit that relates to this medication.
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
PossibleLocation of the visit
Visit.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location.Bed
String
PossibleBed.
Example: B
Visit.AttendingProvider.ID
String
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Insurances[]
Array of Objects
ProbableList of insurance coverages for the patient that should be used for the medication.
Visit.Insurances[].Plan.ID
String
ProbableIdentifier of insurance plan
Visit.Insurances[].Plan.IDType
String
ProbableID type of insurance plan
Visit.Insurances[].Plan.Name
String
ProbableName of insurance plan
Visit.Insurances[].Plan.Type
String
PossibleType of insurance plan
Visit.Insurances[].MemberNumber
String
PossiblePatient member number
Visit.Insurances[].Company.ID
String
ProbableID of insurance company (payor)
Visit.Insurances[].Company.IDType
String
ProbableID type of insurance company (payor)
Visit.Insurances[].Company.Name
String
ProbableName of insurance company (payor)
Visit.Insurances[].Company.Address
Object
ProbableInsurance company's address
Visit.Insurances[].Company.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Company.Address.City
String
ProbableCity
Visit.Insurances[].Company.Address.State
String
ProbableState
Visit.Insurances[].Company.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Company.Address.County
String
PossibleCounty
Visit.Insurances[].Company.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Company.PhoneNumber
String
ProbableInsurance companys phone number.
In E. 164 Format (i.e. +16085551234)
Visit.Insurances[].GroupNumber
String
ProbableInsurance policy group number
Visit.Insurances[].GroupName
String
ProbableInsurance policy group name
Visit.Insurances[].EffectiveDate
String
ProbableEffect date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].ExpirationDate
String
ProbableExpiration date of this insurance policy.
In YYYY-MM-DD format
Visit.Insurances[].PolicyNumber
String
ProbableInsurance policy number
Visit.Insurances[].Priority
String
PossibleValueSetThe insurance priority sequence.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].AgreementType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].CoverageType
String
ProbableValueSetType of insurance agreement.
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured
Object
PossibleIndividual who has the agreement with the insurance company for the related policy
Visit.Insurances[].Insured.Identifiers[]
Array of Objects
PossibleList of IDs and ID types that identify the insured
Visit.Insurances[].Insured.Identifiers[].ID
String
PossibleID for the insured
Visit.Insurances[].Insured.Identifiers[].IDType
String
PossibleType of ID.
E.g. MRN, EPI
Visit.Insurances[].Insured.LastName
String
PossibleLast name of the insured
Visit.Insurances[].Insured.MiddleName
String
PossibleMiddle name of the insured
Visit.Insurances[].Insured.FirstName
String
PossibleFirst name of the insured
Visit.Insurances[].Insured.SSN
String
PossibleInsured's social security number
Visit.Insurances[].Insured.Relationship
String
PossibleValueSetRelationship of the insured to the patient
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.DOB
String
PossibleDate of birth of the insured.
In YYYY-MM-DD format
Visit.Insurances[].Insured.Sex
String
PossibleValueSetSex of the insured
-
Additional values may be added by Redox in the future.
-
Visit.Insurances[].Insured.Address
Object
ProbableAddress of the insured
Visit.Insurances[].Insured.Address.StreetAddress
String
ProbableStreet address
Visit.Insurances[].Insured.Address.City
String
ProbableCity
Visit.Insurances[].Insured.Address.State
String
ProbableState
Visit.Insurances[].Insured.Address.ZIP
String
ProbableZIP
Visit.Insurances[].Insured.Address.County
String
PossibleCounty
Visit.Insurances[].Insured.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order
Order.ID
String
ReliableRequiredID assigned by the ordering system
Order.Notes[]
Array of Strings
PossibleOrder-level notes
Order.Medication.Dose.Quantity
Numeric
ProbableThe size of the dose for pills, capsules, etc.
Order.Medication.Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Rate.Quantity
Numeric
ProbableIf the medication is in liquid form, the rate at which it is administered
Order.Medication.Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Order.Medication.Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Order.Medication.Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.Name
String
ProbableName of the method by which the medication is delivered
Order.Medication.Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Order.Medication.Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Order.Medication.Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Order.Medication.Components[]
Array of Objects
ReliableThe components of the medication
Order.Medication.Components[].Code
String
PossibleA code describing the components of the medication
Order.Medication.Components[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Components[].Name
String
PossibleName of the components of the medication
Order.Medication.Components[].Type
String
ProbableThe type of component.
Allowed values are Base or Additive
Order.Medication.Components[].Dose.Quantity
Numeric
ProbableThe size of the dose for the component.
Order.Medication.Components[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Order.Medication.Product.Code
String
ReliableRequiredA code describing the actual medication given.
Redox recommends using RxNorm
Order.Medication.Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.Name
String
ReliableName of the actual medication given
Order.Medication.Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Order.Medication.Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Order.Medication.Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Order.Medication.Product.AltCodes[].Name
String
PossibleName of the actual medication given
Order.Medication.FreeTextSig
String
PossibleFree text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
Order.Medication.StartDate
String
ReliableWhen the medication should be started.
ISO 8601 Format
Order.Medication.EndDate
String
ProbableWhen the medication should be ended.
ISO 8601 Format
Order.Medication.Frequency.Period
Numeric
ProbableHow often the patient should be taking the medication
Order.Medication.Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication.
UCUM Units of Measure
Order.Medication.IsPRN
Boolean
ProbableWhether the medication is to be taken on an as-needed basis
Order.Medication.Dispense.Amount
Numeric
ProbableThe amount to be dispensed
Order.Medication.Dispense.Units
String
ProbableUnits for the dispensed amount
Order.Medication.NumberOfRefillsRemaining
Numeric
ProbableThe number of authorized refills remaining on the prescription
Order.Indications[]
Array of Objects
ProbableThis field identifies the condition or problem for which the drug/treatment was prescribed.
Order.Indications[].Code
String
ProbableCode
Order.Indications[].Codeset
String
ProbableCode set
Order.Indications[].Description
String
ProbableDescription
Order.Provider.NPI
String
PossibleNPI of the Ordering provider who is licensed to prescribe medications.
Order.Provider.ID
String
PossibleID of the Ordering provider who is licensed to prescribe medications.
This ID is often required for Inpatient Visits.
Order.Provider.IDType
String
PossibleID type of the ID for the Ordering provider who is licensed to prescribe medications.
Order.Provider.FirstName
String
PossibleFirst name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.LastName
String
PossibleLast name of the Ordering provider who is licensed to prescribe medications.
Order.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Ordering provider who is licensed to prescribe medications.
e.g. MD, PhD
Order.Provider.Address
Object
PossibleProvider's address
Order.Provider.Address.StreetAddress
String
PossibleStreet address
Order.Provider.Address.City
String
PossibleCity
Order.Provider.Address.State
String
PossibleState
Order.Provider.Address.ZIP
String
PossibleZIP
Order.Provider.Address.County
String
PossibleCounty
Order.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.Provider.Location
Object
PossibleProvider's location
Order.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Department
String
PossibleDepartment
Order.Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.Provider.Location.Room
String
PossibleRoom.
Example: 136
Order.EnteredBy.ID
String
PossibleID of the The provider who actually entered the order.
This ID is often required for Inpatient Visits.
Order.EnteredBy.IDType
String
PossibleID type of the ID for the The provider who actually entered the order.
Order.EnteredBy.FirstName
String
PossibleFirst name of the The provider who actually entered the order.
Order.EnteredBy.LastName
String
PossibleLast name of the The provider who actually entered the order.
Order.EnteredBy.Credentials[]
Array of Strings
PossibleList of credentials for the The provider who actually entered the order.
e.g. MD, PhD
Order.EnteredBy.Address
Object
PossibleProvider's address
Order.EnteredBy.Address.StreetAddress
String
PossibleStreet address
Order.EnteredBy.Address.City
String
PossibleCity
Order.EnteredBy.Address.State
String
PossibleState
Order.EnteredBy.Address.ZIP
String
PossibleZIP
Order.EnteredBy.Address.County
String
PossibleCounty
Order.EnteredBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.EnteredBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.EnteredBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.EnteredBy.Location
Object
PossibleProvider's location
Order.EnteredBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.EnteredBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.EnteredBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.EnteredBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Department
String
PossibleDepartment
Order.EnteredBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.EnteredBy.Location.Room
String
PossibleRoom.
Example: 136
Order.VerifiedBy.ID
String
PossibleID of the The pharmacist who verified the order.
This ID is often required for Inpatient Visits.
Order.VerifiedBy.IDType
String
PossibleID type of the ID for the The pharmacist who verified the order.
Order.VerifiedBy.FirstName
String
PossibleFirst name of the The pharmacist who verified the order.
Order.VerifiedBy.LastName
String
PossibleLast name of the The pharmacist who verified the order.
Order.VerifiedBy.Credentials[]
Array of Strings
PossibleList of credentials for the The pharmacist who verified the order.
e.g. MD, PhD
Order.VerifiedBy.Address
Object
PossibleProvider's address
Order.VerifiedBy.Address.StreetAddress
String
PossibleStreet address
Order.VerifiedBy.Address.City
String
PossibleCity
Order.VerifiedBy.Address.State
String
PossibleState
Order.VerifiedBy.Address.ZIP
String
PossibleZIP
Order.VerifiedBy.Address.County
String
PossibleCounty
Order.VerifiedBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.VerifiedBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Order.VerifiedBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Order.VerifiedBy.Location
Object
PossibleProvider's location
Order.VerifiedBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Order.VerifiedBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Order.VerifiedBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Department
String
PossibleDepartment
Order.VerifiedBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Order.VerifiedBy.Location.Room
String
PossibleRoom.
Example: 136
Order.Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy
Object
ProbableThe pharmacy at which the medication should be dispensed.
Order.Pharmacy.Code
String
ProbableCode for the pharmacy
Order.Pharmacy.Codeset
String
ProbableCode set used to identify the pharmacy
Order.Pharmacy.Description
String
ProbableDescription of the pharmacy
Order.Pharmacy.Address
Object
ProbableThe physical location at which the medication should be dispensed.
Order.Pharmacy.Address.StreetAddress
String
ProbableStreet address
Order.Pharmacy.Address.City
String
ProbableCity
Order.Pharmacy.Address.State
String
ProbableState
Order.Pharmacy.Address.ZIP
String
ProbableZIP
Order.Pharmacy.Address.County
String
PossibleCounty
Order.Pharmacy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Order.Pharmacy.PhoneNumber.Office
String
PossiblePharmacy's office phone number.
In E. 164 Format. (e.g. +16085551234)
{
"Meta": {
"DataModel": "Medications",
"EventType": "Cancel",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"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,
"Religion": null,
"MaritalStatus": "Single",
"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": [],
"Allergies": [
{
"Code": "7982",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Penicillin",
"AltCodes": [],
"Substance": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Rash",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Hives",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
}
],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Criticality": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Status": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
]
},
"Visit": {
"VisitDateTime": "2023-05-23T13:49:48.956Z",
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Insurances": []
},
"Order": {
"ID": "5e09644b-8364-4990-b787-034fe6049ba7",
"Notes": [],
"Medication": {
"Dose": {
"Quantity": 4,
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"Components": [],
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": []
},
"FreeTextSig": null,
"StartDate": "2023-05-23T13:49:48.033Z",
"EndDate": null,
"Frequency": {
"Period": 8,
"Unit": "h"
},
"IsPRN": null,
"Dispense": {
"Amount": null,
"Units": null
},
"NumberOfRefillsRemaining": null
},
"Indications": [],
"Provider": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"EnteredBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VerifiedBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Priority": null,
"Pharmacy": {
"Code": "1234567",
"Codeset": "NCPDP",
"Description": "Fake Pharmacy",
"Address": {
"StreetAddress": "123 Fake Street",
"City": "Madison",
"State": "WI",
"ZIP": 53703,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
}
}
}
}
Administration events record that a patient received a given medication.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedications
Meta.EventType
String
ReliableRequiredAdministration
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Visit
Visit
Object
ProbableThe visit in which the medication administration was performed.
Visit.VisitDateTime
String
ProbableDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
ProbableVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
ProbableAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
ProbablePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
ProbableLocation of the visit
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ProbableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ProbableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ProbableDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ProbableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ProbableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
ProbableID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
ProbableID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Administrations
Administrations[]
Array of Objects
ProbableMedication Administrations documented as part of this event
Administrations[].Status
String
ReliableRequiredIf the medication was administered the status will be "Complete". This Event can also be used to indicate that a medication was partially given or refused.
Must be eitherComplete
,Refused
, orPartially Administered
Administrations[].Medication
Object
ProbableData about the particular product administered, including dose and route.
Administrations[].Medication.Order.ID
String
ProbableAn identifier for the order that resulted in this administration.
Administrations[].Medication.LotNumber
String
ProbableLot number of the medication administered.
Administrations[].Medication.Dose.Quantity
Numeric
ProbableThe size of the dose for pills, capsules, etc.
Administrations[].Medication.Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Administrations[].Medication.Rate.Quantity
Numeric
ProbableIf the medication is in liquid form, the rate at which it is administered
Administrations[].Medication.Rate.Units
String
ProbableUnits for the rate.
UCUM Units of Measure
Administrations[].Medication.Route.Code
String
ProbableA code describing the method by which the medication is delivered.
Medication Route FDA Value Set
Administrations[].Medication.Route.CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Route.CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Route.Name
String
ProbableName of the method by which the medication is delivered
Administrations[].Medication.Route.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the method by which the medication is delivered
Administrations[].Medication.Route.AltCodes[].Code
String
PossibleA code describing the method by which the medication is delivered
Administrations[].Medication.Route.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Route.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Route.AltCodes[].Name
String
PossibleName of the method by which the medication is delivered
Administrations[].Medication.Components[]
Array of Objects
ReliableThe components of the medication
Administrations[].Medication.Components[].Code
String
PossibleA code describing the components of the medication
Administrations[].Medication.Components[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Components[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Components[].Name
String
PossibleName of the components of the medication
Administrations[].Medication.Components[].Type
String
ProbableThe type of component.
Allowed values are Base or Additive
Administrations[].Medication.Components[].Dose.Quantity
Numeric
ProbableThe size of the dose for the component.
Administrations[].Medication.Components[].Dose.Units
String
ProbableThe units of the dose.
UCUM Units of Measure
Administrations[].Medication.Product.Code
String
ReliableRequiredA code describing the actual medication given.
Redox recommends using RxNorm
Administrations[].Medication.Product.CodeSystem
String
ReliableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Product.CodeSystemName
String
ReliableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Product.Name
String
ReliableName of the actual medication given
Administrations[].Medication.Product.AltCodes[]
Array of Objects
PossibleAlternate or translation codes for the actual medication given
Administrations[].Medication.Product.AltCodes[].Code
String
PossibleA code describing the actual medication given
Administrations[].Medication.Product.AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Product.AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Administrations[].Medication.Product.AltCodes[].Name
String
PossibleName of the actual medication given
Administrations[].Medication.Indications[]
Array of Objects
ProbableThis field identifies the condition or problem for which the drug/treatment was prescribed.
Administrations[].Medication.Indications[].Code
String
ProbableCode
Administrations[].Medication.Indications[].Codeset
String
ProbableCode set
Administrations[].Medication.Indications[].Description
String
ProbableDescription
Administrations[].StartDate
String
ReliableWhen the administration started.
ISO 8601 Format. In the event that the administration was
Administrations[].EndDate
String
ProbableWhen the administration ended.
ISO 8601 Format
Administrations[].AdministeringProvider.NPI
String
PossibleNPI of the The provider who actually administered the medication.
Administrations[].AdministeringProvider.ID
String
PossibleID of the The provider who actually administered the medication.
This ID is often required for Inpatient Visits.
Administrations[].AdministeringProvider.IDType
String
PossibleID type of the ID for the The provider who actually administered the medication.
Administrations[].AdministeringProvider.FirstName
String
PossibleFirst name of the The provider who actually administered the medication.
Administrations[].AdministeringProvider.LastName
String
PossibleLast name of the The provider who actually administered the medication.
Administrations[].AdministeringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the The provider who actually administered the medication.
e.g. MD, PhD
Administrations[].AdministeringProvider.Address
Object
PossibleProvider's address
Administrations[].AdministeringProvider.Address.StreetAddress
String
PossibleStreet address
Administrations[].AdministeringProvider.Address.City
String
PossibleCity
Administrations[].AdministeringProvider.Address.State
String
PossibleState
Administrations[].AdministeringProvider.Address.ZIP
String
PossibleZIP
Administrations[].AdministeringProvider.Address.County
String
PossibleCounty
Administrations[].AdministeringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Administrations[].AdministeringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Administrations[].AdministeringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Administrations[].AdministeringProvider.Location
Object
PossibleProvider's location
Administrations[].AdministeringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Administrations[].AdministeringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Administrations[].AdministeringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Administrations[].AdministeringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Administrations[].AdministeringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].AdministeringProvider.Location.Department
String
PossibleDepartment
Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].AdministeringProvider.Location.Room
String
PossibleRoom.
Example: 136
Administrations[].OrderedBy.ID
String
PossibleID of the The provider who actually entered the order.
This ID is often required for Inpatient Visits.
Administrations[].OrderedBy.IDType
String
PossibleID type of the ID for the The provider who actually entered the order.
Administrations[].OrderedBy.FirstName
String
PossibleFirst name of the The provider who actually entered the order.
Administrations[].OrderedBy.LastName
String
PossibleLast name of the The provider who actually entered the order.
Administrations[].OrderedBy.Credentials[]
Array of Strings
PossibleList of credentials for the The provider who actually entered the order.
e.g. MD, PhD
Administrations[].OrderedBy.Address
Object
PossibleProvider's address
Administrations[].OrderedBy.Address.StreetAddress
String
PossibleStreet address
Administrations[].OrderedBy.Address.City
String
PossibleCity
Administrations[].OrderedBy.Address.State
String
PossibleState
Administrations[].OrderedBy.Address.ZIP
String
PossibleZIP
Administrations[].OrderedBy.Address.County
String
PossibleCounty
Administrations[].OrderedBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Administrations[].OrderedBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Administrations[].OrderedBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Administrations[].OrderedBy.Location
Object
PossibleProvider's location
Administrations[].OrderedBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Administrations[].OrderedBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Administrations[].OrderedBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Administrations[].OrderedBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Administrations[].OrderedBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].OrderedBy.Location.Department
String
PossibleDepartment
Administrations[].OrderedBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Administrations[].OrderedBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Administrations[].OrderedBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].OrderedBy.Location.Room
String
PossibleRoom.
Example: 136
Administrations[].VerifiedBy.ID
String
PossibleID of the The pharmacist who verified the order.
This ID is often required for Inpatient Visits.
Administrations[].VerifiedBy.IDType
String
PossibleID type of the ID for the The pharmacist who verified the order.
Administrations[].VerifiedBy.FirstName
String
PossibleFirst name of the The pharmacist who verified the order.
Administrations[].VerifiedBy.LastName
String
PossibleLast name of the The pharmacist who verified the order.
Administrations[].VerifiedBy.Credentials[]
Array of Strings
PossibleList of credentials for the The pharmacist who verified the order.
e.g. MD, PhD
Administrations[].VerifiedBy.Address
Object
PossibleProvider's address
Administrations[].VerifiedBy.Address.StreetAddress
String
PossibleStreet address
Administrations[].VerifiedBy.Address.City
String
PossibleCity
Administrations[].VerifiedBy.Address.State
String
PossibleState
Administrations[].VerifiedBy.Address.ZIP
String
PossibleZIP
Administrations[].VerifiedBy.Address.County
String
PossibleCounty
Administrations[].VerifiedBy.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Administrations[].VerifiedBy.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Administrations[].VerifiedBy.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Administrations[].VerifiedBy.Location
Object
PossibleProvider's location
Administrations[].VerifiedBy.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Administrations[].VerifiedBy.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Administrations[].VerifiedBy.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Administrations[].VerifiedBy.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Administrations[].VerifiedBy.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].VerifiedBy.Location.Department
String
PossibleDepartment
Administrations[].VerifiedBy.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Administrations[].VerifiedBy.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Administrations[].VerifiedBy.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Administrations[].VerifiedBy.Location.Room
String
PossibleRoom.
Example: 136
{
"Meta": {
"DataModel": "Medications",
"EventType": "Administration",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"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,
"Religion": null,
"MaritalStatus": "Single",
"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": []
},
"Visit": {
"VisitDateTime": "2023-05-23T13:49:48.964Z",
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
}
},
"Administrations": [
{
"Status": "Complete",
"Medication": {
"Order": {
"ID": "e0de5be6-16e0-4b94-b887-39f1eed5b3b4"
},
"LotNumber": null,
"Dose": {
"Quantity": 4,
"Units": "mg"
},
"Rate": {
"Quantity": null,
"Units": null
},
"Route": {
"Code": "C38288",
"CodeSystem": "2.16.840.1.113883.3.26.1.1",
"CodeSystemName": "NCI Thesaurus",
"Name": "Oral",
"AltCodes": []
},
"Components": [],
"Product": {
"Code": "104894",
"CodeSystem": "2.16.840.1.113883.6.88",
"CodeSystemName": "RxNorm",
"Name": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": []
},
"Indications": []
},
"StartDate": "2023-05-23T13:49:48.033Z",
"EndDate": null,
"AdministeringProvider": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"OrderedBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VerifiedBy": {
"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,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
}
}
]
}