Media
Media messages are used to add documents to a patient's chart. In particular, PDF reports can be added to a patient's chart using Media messages.
A New message is used to add a new document to the patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedia
Meta.EventType
String
ReliableRequiredNew
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
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.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.VisitNumber
String
ReliableVisit Number.
A VisitNumber is highly recommended so that the document can be associated with a specific 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.Location
Object
ProbableLocation of the patient. This may be used for validation or to identify your application/device.
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.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Media
Media.FileType
String
ReliableRequiredFile type of the document.
E.g. PDF, JPG
Media.FileName
String
ReliableRequiredName of the file
Media.FileContents
String (Base64)
ReliableRequired
Media.DocumentType
String
ReliableRequiredType of Document.
This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
Media.DocumentID
String
ReliableRequiredUnique identifier for this document.
This ID is required in order to update the document
Media.DocumentDescription
String
PossibleDescriptive label for this document.
Media.CreationDateTime
DateTime
PossibleThis time represents when this media was created.
ISO 8601 Format
Media.ServiceDateTime
DateTime
PossibleThis time represents a clinical service timestamp with which this media is related.
ISO 8601 Format
Media.Provider.ID
String
ReliableRequiredID of the Provider responsible for the document
Media.Provider.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Media.Provider.FirstName
String
PossibleFirst name of the Provider responsible for the document
Media.Provider.LastName
String
PossibleLast name of the Provider responsible for the document
Media.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Media.Provider.Address
Object
PossibleProvider's address
Media.Provider.Address.StreetAddress
String
PossibleStreet address
Media.Provider.Address.City
String
PossibleCity
Media.Provider.Address.State
String
PossibleState
Media.Provider.Address.ZIP
String
PossibleZIP
Media.Provider.Address.County
String
PossibleCounty
Media.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Provider.Location
Object
PossibleProvider's location
Media.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Provider.Location.Department
String
PossibleDepartment
Media.Provider.Location.Room
String
PossibleRoom.
Example: 136
Media.Authenticated
String
ReliableThe authenticated status of the document.
True or False. If True, it is recommended to have Media.Authenticator filled out
Media.Authenticator.ID
String
ReliableID of the provider who authenticated the document.
This ID is often required for Inpatient Visits.
Media.Authenticator.IDType
String
ReliableID type of the ID for the provider who authenticated the document
Media.Authenticator.FirstName
String
PossibleFirst name of the provider who authenticated the document
Media.Authenticator.LastName
String
PossibleLast name of the provider who authenticated the document
Media.Authenticator.Credentials[]
Array of Strings
PossibleList of credentials for the provider who authenticated the document.
e.g. MD, PhD
Media.Authenticator.Address
Object
PossibleProvider's address
Media.Authenticator.Address.StreetAddress
String
PossibleStreet address
Media.Authenticator.Address.City
String
PossibleCity
Media.Authenticator.Address.State
String
PossibleState
Media.Authenticator.Address.ZIP
String
PossibleZIP
Media.Authenticator.Address.County
String
PossibleCounty
Media.Authenticator.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Authenticator.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Authenticator.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Authenticator.Location
Object
PossibleProvider's location
Media.Authenticator.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Authenticator.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Authenticator.Location.Department
String
PossibleDepartment
Media.Authenticator.Location.Room
String
PossibleRoom.
Example: 136
Media.Availability
String
ReliableValueSetRequiredWhether the document is available
-
Additional values may be added by Redox in the future.
-
Media.Notifications[]
Array of Objects
ReliableList of providers that should be notified when this document posts to the patient's chart
Media.Notifications[].ID
String
ReliableID of the provider who should be notified.
This ID is often required for Inpatient Visits.
Media.Notifications[].IDType
String
ReliableID type of the ID for the provider who should be notified
Media.Notifications[].FirstName
String
PossibleFirst name of the provider who should be notified
Media.Notifications[].LastName
String
PossibleLast name of the provider who should be notified
Media.Notifications[].Credentials[]
Array of Strings
PossibleList of credentials for the provider who should be notified.
e.g. MD, PhD
Media.Notifications[].Address
Object
PossibleProvider's address
Media.Notifications[].Address.StreetAddress
String
PossibleStreet address
Media.Notifications[].Address.City
String
PossibleCity
Media.Notifications[].Address.State
String
PossibleState
Media.Notifications[].Address.ZIP
String
PossibleZIP
Media.Notifications[].Address.County
String
PossibleCounty
Media.Notifications[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Notifications[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Notifications[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Notifications[].Location
Object
PossibleProvider's location
Media.Notifications[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Notifications[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Notifications[].Location.Department
String
PossibleDepartment
Media.Notifications[].Location.Room
String
PossibleRoom.
Example: 136
{
"Meta": {
"DataModel": "Media",
"EventType": "New",
"EventDateTime": "2021-04-08T17:09:17.614Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null,
"Bed": null
}
},
"Media": {
"FileType": "PDF",
"FileName": "SamplePDF",
"FileContents": "<...base 64 file contents...>",
"DocumentType": "Empty File",
"DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
"DocumentDescription": null,
"CreationDateTime": "2017-06-22T19:30:04.387Z",
"ServiceDateTime": "2017-06-22T17:00:00.387Z",
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Authenticated": "False",
"Authenticator": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Availability": "Unavailable",
"Notifications": [
{
"ID": "2434534567",
"IDType": "NPI",
"FirstName": "Sharon",
"LastName": "Chalk",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "312 Maple Dr. Suite 400",
"City": "Verona",
"State": "WI",
"ZIP": "53593",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
{
"ID": "8263749385",
"IDType": "NPI",
"FirstName": "Jim",
"LastName": "Mica",
"Credentials": [
"RN"
],
"Address": {
"StreetAddress": "5235 Kennedy Ave.",
"City": "Creve Cour",
"State": "MO",
"ZIP": "63141",
"County": "Saint Louis",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145557777"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
]
}
}
A Replace Media message is used to replace a document that was previously added to the patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedia
Meta.EventType
String
ReliableRequiredReplace
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
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.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.VisitNumber
String
ReliableVisit Number.
A VisitNumber is highly recommended so that the document can be associated with a specific 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.Location
Object
ProbableLocation of the patient. This may be used for validation or to identify your application/device.
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.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Media
Media.FileType
String
ReliableRequiredFile type of the document.
E.g. PDF, JPG
Media.FileName
String
ReliableRequiredName of the file
Media.FileContents
String (Base64)
ReliableRequired
Media.DocumentType
String
ReliableRequiredType of Document.
This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
Media.OriginalDocumentID
String
PossibleRequiredID of the document being replaced
Media.DocumentID
String
ReliableRequiredUnique identifier for this document.
This ID is required in order to update the document
Media.DocumentDescription
String
PossibleDescriptive label for this document.
Media.CreationDateTime
DateTime
PossibleThis time represents when this media was created.
ISO 8601 Format
Media.ServiceDateTime
DateTime
PossibleThis time represents a clinical service timestamp with which this media is related.
ISO 8601 Format
Media.Provider.ID
String
ReliableRequiredID of the Provider responsible for the document
Media.Provider.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Media.Provider.FirstName
String
PossibleFirst name of the Provider responsible for the document
Media.Provider.LastName
String
PossibleLast name of the Provider responsible for the document
Media.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Media.Provider.Address
Object
PossibleProvider's address
Media.Provider.Address.StreetAddress
String
PossibleStreet address
Media.Provider.Address.City
String
PossibleCity
Media.Provider.Address.State
String
PossibleState
Media.Provider.Address.ZIP
String
PossibleZIP
Media.Provider.Address.County
String
PossibleCounty
Media.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Provider.Location
Object
PossibleProvider's location
Media.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Provider.Location.Department
String
PossibleDepartment
Media.Provider.Location.Room
String
PossibleRoom.
Example: 136
Media.Authenticated
String
ReliableThe authenticated status of the document.
True or False. If True, it is recommended to have Media.Authenticator filled out
Media.Authenticator.ID
String
ReliableID of the provider who authenticated the document.
This ID is often required for Inpatient Visits.
Media.Authenticator.IDType
String
ReliableID type of the ID for the provider who authenticated the document
Media.Authenticator.FirstName
String
PossibleFirst name of the provider who authenticated the document
Media.Authenticator.LastName
String
PossibleLast name of the provider who authenticated the document
Media.Authenticator.Credentials[]
Array of Strings
PossibleList of credentials for the provider who authenticated the document.
e.g. MD, PhD
Media.Authenticator.Address
Object
PossibleProvider's address
Media.Authenticator.Address.StreetAddress
String
PossibleStreet address
Media.Authenticator.Address.City
String
PossibleCity
Media.Authenticator.Address.State
String
PossibleState
Media.Authenticator.Address.ZIP
String
PossibleZIP
Media.Authenticator.Address.County
String
PossibleCounty
Media.Authenticator.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Authenticator.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Authenticator.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Authenticator.Location
Object
PossibleProvider's location
Media.Authenticator.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Authenticator.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Authenticator.Location.Department
String
PossibleDepartment
Media.Authenticator.Location.Room
String
PossibleRoom.
Example: 136
Media.Availability
String
ReliableValueSetRequiredWhether the document is available
-
Additional values may be added by Redox in the future.
-
Media.Notifications[]
Array of Objects
ReliableList of providers that should be notified when this document posts to the patient's chart
Media.Notifications[].ID
String
ReliableID of the provider who should be notified.
This ID is often required for Inpatient Visits.
Media.Notifications[].IDType
String
ReliableID type of the ID for the provider who should be notified
Media.Notifications[].FirstName
String
PossibleFirst name of the provider who should be notified
Media.Notifications[].LastName
String
PossibleLast name of the provider who should be notified
Media.Notifications[].Credentials[]
Array of Strings
PossibleList of credentials for the provider who should be notified.
e.g. MD, PhD
Media.Notifications[].Address
Object
PossibleProvider's address
Media.Notifications[].Address.StreetAddress
String
PossibleStreet address
Media.Notifications[].Address.City
String
PossibleCity
Media.Notifications[].Address.State
String
PossibleState
Media.Notifications[].Address.ZIP
String
PossibleZIP
Media.Notifications[].Address.County
String
PossibleCounty
Media.Notifications[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Notifications[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Notifications[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Notifications[].Location
Object
PossibleProvider's location
Media.Notifications[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Notifications[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Notifications[].Location.Department
String
PossibleDepartment
Media.Notifications[].Location.Room
String
PossibleRoom.
Example: 136
{
"Meta": {
"DataModel": "Media",
"EventType": "Replace",
"EventDateTime": "2021-04-08T17:09:17.614Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null,
"Bed": null
}
},
"Media": {
"FileType": "PDF",
"FileName": "SamplePDF",
"FileContents": "<...base 64 file contents...>",
"DocumentType": "Empty File",
"OriginalDocumentID": "2cdba2d2-792b-4ed2-99cd-34e7eb0ad0dc",
"DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
"DocumentDescription": null,
"CreationDateTime": "2017-06-22T19:30:04.387Z",
"ServiceDateTime": "2017-06-22T17:00:00.387Z",
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Authenticated": "False",
"Authenticator": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Availability": "Unavailable",
"Notifications": [
{
"ID": "2434534567",
"IDType": "NPI",
"FirstName": "Sharon",
"LastName": "Chalk",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "312 Maple Dr. Suite 400",
"City": "Verona",
"State": "WI",
"ZIP": "53593",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
{
"ID": "8263749385",
"IDType": "NPI",
"FirstName": "Jim",
"LastName": "Mica",
"Credentials": [
"RN"
],
"Address": {
"StreetAddress": "5235 Kennedy Ave.",
"City": "Creve Cour",
"State": "MO",
"ZIP": "63141",
"County": "Saint Louis",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145557777"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
]
}
}
A Delete Media message is used to delete a document that was previously added to the patient's chart.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedia
Meta.EventType
String
ReliableRequiredDelete
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
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.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.VisitNumber
String
ReliableVisit Number.
A VisitNumber is highly recommended so that the document can be associated with a specific 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.Location
Object
ProbableLocation of the patient. This may be used for validation or to identify your application/device.
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.Department
String
ProbableDepartment
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Location.Bed
String
ProbableBed.
Example: B
Media
Media.FileType
String
ReliableRequiredFile type of the document.
E.g. PDF, JPG
Media.FileName
String
ReliableRequiredName of the file
Media.DocumentType
String
ReliableRequiredType of Document.
This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
Media.DocumentID
String
ReliableRequiredUnique identifier for this document.
This ID is required in order to update the document
Media.DocumentDescription
String
PossibleDescriptive label for this document.
Media.CreationDateTime
DateTime
PossibleThis time represents when this media was created.
ISO 8601 Format
Media.ServiceDateTime
DateTime
PossibleThis time represents a clinical service timestamp with which this media is related.
ISO 8601 Format
Media.Provider.ID
String
ReliableRequiredID of the Provider responsible for the document
Media.Provider.IDType
String
ReliableID type of the ID for the Provider responsible for the document
Media.Provider.FirstName
String
PossibleFirst name of the Provider responsible for the document
Media.Provider.LastName
String
PossibleLast name of the Provider responsible for the document
Media.Provider.Credentials[]
Array of Strings
PossibleList of credentials for the Provider responsible for the document.
e.g. MD, PhD
Media.Provider.Address
Object
PossibleProvider's address
Media.Provider.Address.StreetAddress
String
PossibleStreet address
Media.Provider.Address.City
String
PossibleCity
Media.Provider.Address.State
String
PossibleState
Media.Provider.Address.ZIP
String
PossibleZIP
Media.Provider.Address.County
String
PossibleCounty
Media.Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Provider.Location
Object
PossibleProvider's location
Media.Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Provider.Location.Department
String
PossibleDepartment
Media.Provider.Location.Room
String
PossibleRoom.
Example: 136
Media.Authenticated
String
ReliableThe authenticated status of the document.
True or False. If True, it is recommended to have Media.Authenticator filled out
Media.Authenticator.ID
String
ReliableID of the provider who authenticated the document.
This ID is often required for Inpatient Visits.
Media.Authenticator.IDType
String
ReliableID type of the ID for the provider who authenticated the document
Media.Authenticator.FirstName
String
PossibleFirst name of the provider who authenticated the document
Media.Authenticator.LastName
String
PossibleLast name of the provider who authenticated the document
Media.Authenticator.Credentials[]
Array of Strings
PossibleList of credentials for the provider who authenticated the document.
e.g. MD, PhD
Media.Authenticator.Address
Object
PossibleProvider's address
Media.Authenticator.Address.StreetAddress
String
PossibleStreet address
Media.Authenticator.Address.City
String
PossibleCity
Media.Authenticator.Address.State
String
PossibleState
Media.Authenticator.Address.ZIP
String
PossibleZIP
Media.Authenticator.Address.County
String
PossibleCounty
Media.Authenticator.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Authenticator.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Authenticator.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Authenticator.Location
Object
PossibleProvider's location
Media.Authenticator.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Authenticator.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Authenticator.Location.Department
String
PossibleDepartment
Media.Authenticator.Location.Room
String
PossibleRoom.
Example: 136
Media.Availability
String
ReliableValueSetRequiredWhether the document is available
-
Additional values may be added by Redox in the future.
-
Media.Notifications[]
Array of Objects
ReliableList of providers that should be notified when this document posts to the patient's chart
Media.Notifications[].ID
String
ReliableID of the provider who should be notified.
This ID is often required for Inpatient Visits.
Media.Notifications[].IDType
String
ReliableID type of the ID for the provider who should be notified
Media.Notifications[].FirstName
String
PossibleFirst name of the provider who should be notified
Media.Notifications[].LastName
String
PossibleLast name of the provider who should be notified
Media.Notifications[].Credentials[]
Array of Strings
PossibleList of credentials for the provider who should be notified.
e.g. MD, PhD
Media.Notifications[].Address
Object
PossibleProvider's address
Media.Notifications[].Address.StreetAddress
String
PossibleStreet address
Media.Notifications[].Address.City
String
PossibleCity
Media.Notifications[].Address.State
String
PossibleState
Media.Notifications[].Address.ZIP
String
PossibleZIP
Media.Notifications[].Address.County
String
PossibleCounty
Media.Notifications[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Media.Notifications[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Media.Notifications[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Media.Notifications[].Location
Object
PossibleProvider's location
Media.Notifications[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Media.Notifications[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Media.Notifications[].Location.Department
String
PossibleDepartment
Media.Notifications[].Location.Room
String
PossibleRoom.
Example: 136
{
"Meta": {
"DataModel": "Media",
"EventType": "Delete",
"EventDateTime": "2021-04-08T17:09:17.614Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null,
"Bed": null
}
},
"Media": {
"FileType": "PDF",
"FileName": "SamplePDF",
"DocumentType": "Empty File",
"DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
"DocumentDescription": null,
"CreationDateTime": "2017-06-22T19:30:04.387Z",
"ServiceDateTime": "2017-06-22T17:00:00.387Z",
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Authenticated": "False",
"Authenticator": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"Availability": "Unavailable",
"Notifications": [
{
"ID": "2434534567",
"IDType": "NPI",
"FirstName": "Sharon",
"LastName": "Chalk",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "312 Maple Dr. Suite 400",
"City": "Verona",
"State": "WI",
"ZIP": "53593",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
{
"ID": "8263749385",
"IDType": "NPI",
"FirstName": "Jim",
"LastName": "Mica",
"Credentials": [
"RN"
],
"Address": {
"StreetAddress": "5235 Kennedy Ave.",
"City": "Creve Cour",
"State": "MO",
"ZIP": "63141",
"County": "Saint Louis",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145557777"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
]
}
}
This query can be used to retrieve Media documents based on the specified filter criteria. The format of the response is specified by the Media QueryResponse event type.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedia
Meta.EventType
String
ReliableRequiredQuery
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
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.
Patients
Patients[]
Array of Objects
ReliableArray of patients to filter results on.
If multiple patients are provided, media associated with any of the patients will be returned.
Patients[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient.
If multiple identifiers are provided, only patients with all identifiers will be considered.
Patients[].Identifiers[].ID
String
ReliableID of the Patient
Patients[].Identifiers[].IDType
String
ReliableID Type for the corresponding ID of this patient (ie. MRN, EHRID)
VisitNumbers
VisitNumbers[]
Array of Strings
ReliableArray of patient visits to query on.
If multiple visits are provided, media associated with any of the patient visits will be returned.
DocumentTypes
DocumentTypes[]
Array of Strings
ReliableArray of document types to query on.
The type of media to retrieve (E.g. Consent Form, Treatment Plan)
DocumentIDs
DocumentIDs[]
Array of Strings
ReliableArray of document identifiers to query on.
{
"Meta": {
"DataModel": "Media",
"EventType": "Query",
"EventDateTime": "2021-04-08T17:09:17.614Z",
"Test": true,
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"FacilityCode": null
},
"Patients": [
{
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
]
}
],
"VisitNumbers": [
"1234",
"5678"
],
"DocumentTypes": [
"Sample Image",
"Sample Image"
],
"DocumentIDs": [
"b169923c-42g9-4fe3-91hg-8ckf1094e90l"
]
}
This is the response format for a Media Query.
Fields
Meta
Meta.DataModel
String
ReliableRequiredMedia
Meta.EventType
String
ReliableRequiredQueryResponse
Meta.EventDateTime
DateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox
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.
Media
Media[].Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Media[].Patient.Identifiers[].ID
String
ReliableID for the patient
Media[].Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Media[].Visit.VisitNumber
String
ReliableVisit Number.
A VisitNumber is highly recommended so that the document can be associated with a specific visit
Media[].FileType
String
ReliableFile type of the document.
E.g. PDF, JPG
Media[].FileName
String
ReliableName of the file
Media[].FileContents
String (Base64)
Reliable
Media[].DocumentType
String
ReliableType of Document.
This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
Media[].DocumentID
String
ReliableUnique identifier for this document.
This ID is required in order to update the document
Media[].DocumentDescription
String
PossibleDescriptive label for this document.
Media[].CreationDateTime
DateTime
PossibleThis time represents when this media was created.
ISO 8601 Format
Media[].ServiceDateTime
DateTime
PossibleThis time represents a clinical service timestamp with which this media is related.
ISO 8601 Format
{
"Meta": {
"DataModel": "Media",
"EventType": "QueryResponse",
"EventDateTime": "2021-04-08T17:09:17.614Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Media": [
{
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
]
},
"Visit": {
"VisitNumber": "1234"
},
"FileType": "JPG",
"FileName": "SampleImage",
"FileContents": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDACgcHiMeGSgjISMtKygwPGRBPDc3PHtYXUlkkYCZlo+AjIqgtObDoKrarYqMyP/L2u71////m8H////6/+b9//j/2wBDASstLTw1PHZBQXb4pYyl+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj4+Pj/wAARCAAyARMDAREAAhEBAxEB/8QAGQABAQEBAQEAAAAAAAAAAAAAAAMEBQIB/8QAMhAAAgICAAUCBAYABwEAAAAAAQIAAwQRBRIhMUETUTJhkdEUNHOBscEVIiMzQnHwof/EABQBAQAAAAAAAAAAAAAAAAAAAAD/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDswEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQJZZK4d7KSCK2II8dIEeFu1nD6mdizHeyTs9zAlxuyyrDRq3ZD6gG1OvBgdCBlfiWGj8pvXfyBI+sDSrK6hkYMp7EeYHN4B+Sf8AUP8AAgOF/neIfqf20Ddfk04wBusCb7e5gKMmnJBNNgfXf3ECsCGZkri47WMdHqF6b2ddBA4uLXiZXKcnKt/EO2tDfffTrqB2zl0La9TWAOg5mB6aHTz+4gMfKpyeb0X5+Xv0IgeH4jiV2cjXrzD22YGhWV1DKQVPYjzAzjiOIa/U9deXeuoO/pA9VZuNcrNXcpC9Tvpr6wPC8RxHsCLevMenY6+sDVAQOLVVkZmZlquZbUK7CAASfJ+fygUV8rAzaarrjdVcdAnuD/4wOsSFBJIAHcmBl/xLD5+X113/ANHX1gagQRsHYMDNZxDErs5HuUMO+tnUDJwlg2XnspBBs2CPPVoG+/JpxgDdYE329zAUZNOSCabA+u/uIBsqlMhaGfVjdgQev79oHq++vHr9S1uVe24H2t1sRXTZVhsbGoHqBHN/JX/pt/EDlYFXEWw6zj5FaVdeUEdR1PygT4nXnJjqcq6t05xoKPOj8hA6HGbWqwDynRdgpPy/8IGGvL4WlIrOK7dOrFRs/vuBo4HYGW+td+mrbTfcA7+0D1wD8k/6h/gQHC/zvEP1P7aB4xqkzOKZT3qHFR5VU9vP2gMmpMPimK9ChBaeVlHbx94HWgZ89FfCu5lDcqMRsb0dHrAz8JopbApsNVZfZPMVG+58wIfh68jj162rzKqBte/RYGvNVMTAveitayQBtRrzr+4E8HAxjg189SuzqGLEdesDzwclDk4+yVqs0P8A79oEOC4lF1D221h2D8o5uo1oeP3gfMjDoPGqqeTVbrzFV6e/2gX4rh49fD3eupEZNaKjXnUDdisXxKWY7JRSfpArA4eO+Ymbm/hKks3YebmPbqdeR84FMLnzs425TgPQelQGtfOBTjlvJXTWSQjtt9d9DX3gZmy+Fmk1jFcdNc3KN/XcCmLkuvArWBPMhKA+29feBpwMDHGHWz1I7OoYlhvvAnwhQmXnKo0quAB7DbQPONUmZxTKe9Q4qPKqnt5+0Bk1Jh8UxXoUILTyso7ePvA2cQxBlUdDy2J1RvaBgxWfityeuR6dAG1B+I+8DswECWWC2HeqgkmtgAPPSBHhaNXw+pXUqw3sEaPcwJcbrstw0WtGc+oDpRvwYGjOxvxeK1W9N3U/OBjXNz6VCW4TWMOnMvn6AwNeHdkXc7X0ekOnKN9T7/1AhwSuyrDdbEZD6hOmGvAgOG12JmZzOjKGs2pI1vqe0Cd1eThZtmRj1G6u34lHcGApryM3NryMio011fCp7kwOpAllgth3qoJJrYADz0gR4WjV8PqV1KsN7BGj3MCVNdg45kWFGCGsANrofh8wNmTSMjHeonXMNb9oHMqyM/EqGOcQ2FeiuN61A18MxXx6Wa7/AHbG5m+UCfBK7KsN1sRkPqE6Ya8CAursPHMewIxQVkFtdB8XmBXiiNZw+1UUsx1oAbPcQLYgK4dCsCCK1BB8dIFYHP4bXYmZnM6MoazakjW+p7QHEMWwWLmYo/1k7gf8hA+5NT5+LXaitVfWeZVca0faBMcQzU/yvgOze671/EC4S7NwbUyKxUz9FG99PBP7wMuPkZ+PUuN+DLsvRX30gU4TXcl+W16FWZgd60CdneoHm6vJws2zIx6jdXb8SjuDAU15Gbm15GRUaa6vhU9yYFeItfcy4lCOA/x2cp0B7bgSycNsRqsjCQkoAroBvmEDpVv6lavysuxvTDRED1AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQP//Z",
"DocumentType": "Sample Image",
"DocumentID": "b169923c-42g9-4fe3-91hg-8ckf1094e90l",
"DocumentDescription": null,
"CreationDateTime": "2017-06-22T19:30:04.387Z",
"ServiceDateTime": "2017-06-22T17:00:00.387Z"
}
]
}