Redox | Media

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.

Media FAQ^

The Media data model has events that are enabled for Data on Demand. Learn more about what that means here.

New
Replace
Delete
Query
QueryResponse

New

A New message is used to add a new document to the patient's chart.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Media
- Meta.EventType
  String
  Reliable
  Required
  New
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List 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
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code 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
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient'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
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  A VisitNumber is highly recommended so that the document can be associated with a specific visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.Location
  Object
  Probable
  Location of the patient. This may be used for validation or to identify your application/device.
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
Media
- Media.FileType
  String
  Reliable
  Required
  File type of the document.
  E.g. PDF, JPG
- Media.FileName
  String
  Reliable
  Required
  Name of the file
- Media.FileContents
  String (Base64)
  Reliable
  Required
  Redox BLOB URI
- Media.DocumentType
  String
  Reliable
  Required
  Type of Document.
  This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
- Media.DocumentID
  String
  Reliable
  Required
  Unique identifier for this document.
  This ID is required in order to update the document
- Media.DocumentDescription
  String
  Possible
  Descriptive label for this document.
- Media.CreationDateTime
  DateTime
  Possible
  This time represents when this media was created.
  ISO 8601 Format
- Media.ServiceDateTime
  DateTime
  Possible
  This time represents a clinical service timestamp with which this media is related.
  ISO 8601 Format
- Media.DirectAddressFrom
  String
  Possible
  The sender's Direct address, if one or both sides are using Direct messaging.
- Media.DirectAddressTo
  String
  Possible
  The recipient's Direct address, if one or both sides are using Direct messaging.
- Media.Provider.ID
  String
  Reliable
  Required
  ID of the Provider responsible for the document
- Media.Provider.IDType
  String
  Reliable
  ID type of the ID for the Provider responsible for the document
- Media.Provider.FirstName
  String
  Possible
  First name of the Provider responsible for the document
- Media.Provider.LastName
  String
  Possible
  Last name of the Provider responsible for the document
- Media.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Provider responsible for the document.
  e.g. MD, PhD
- Media.Provider.Address
  Object
  Possible
  Provider's address
- Media.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Media.Provider.Address.City
  String
  Possible
  City
- Media.Provider.Address.State
  String
  Possible
  State
- Media.Provider.Address.ZIP
  String
  Possible
  ZIP
- Media.Provider.Address.County
  String
  Possible
  County
- Media.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Provider.Location
  Object
  Possible
  Provider's location
- Media.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Provider.Location.Department
  String
  Possible
  Department
- Media.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Authenticated
  String
  Reliable
  The authenticated status of the document.
  True or False. If True, it is recommended to have Media.Authenticator filled out
- Media.Authenticator.ID
  String
  Reliable
  ID of the provider who authenticated the document.
  This ID is often required for Inpatient Visits.
- Media.Authenticator.IDType
  String
  Reliable
  ID type of the ID for the provider who authenticated the document
- Media.Authenticator.FirstName
  String
  Possible
  First name of the provider who authenticated the document
- Media.Authenticator.LastName
  String
  Possible
  Last name of the provider who authenticated the document
- Media.Authenticator.Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who authenticated the document.
  e.g. MD, PhD
- Media.Authenticator.Address
  Object
  Possible
  Provider's address
- Media.Authenticator.Address.StreetAddress
  String
  Possible
  Street address
- Media.Authenticator.Address.City
  String
  Possible
  City
- Media.Authenticator.Address.State
  String
  Possible
  State
- Media.Authenticator.Address.ZIP
  String
  Possible
  ZIP
- Media.Authenticator.Address.County
  String
  Possible
  County
- Media.Authenticator.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Authenticator.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Authenticator.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Authenticator.Location
  Object
  Possible
  Provider's location
- Media.Authenticator.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Authenticator.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Authenticator.Location.Department
  String
  Possible
  Department
- Media.Authenticator.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Availability
  String
  Reliable
  ValueSet
  Required
  Whether the document is available
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[]
  Array of Objects
  Reliable
  List of providers that should be notified when this document posts to the patient's chart
- Media.Notifications[].ID
  String
  Reliable
  ID of the provider who should be notified.
  This ID is often required for Inpatient Visits.
- Media.Notifications[].IDType
  String
  Reliable
  ID type of the ID for the provider who should be notified
- Media.Notifications[].FirstName
  String
  Possible
  First name of the provider who should be notified
- Media.Notifications[].LastName
  String
  Possible
  Last name of the provider who should be notified
- Media.Notifications[].Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who should be notified.
  e.g. MD, PhD
- Media.Notifications[].Address
  Object
  Possible
  Provider's address
- Media.Notifications[].Address.StreetAddress
  String
  Possible
  Street address
- Media.Notifications[].Address.City
  String
  Possible
  City
- Media.Notifications[].Address.State
  String
  Possible
  State
- Media.Notifications[].Address.ZIP
  String
  Possible
  ZIP
- Media.Notifications[].Address.County
  String
  Possible
  County
- Media.Notifications[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[].EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Notifications[].PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Notifications[].Location
  Object
  Possible
  Provider's location
- Media.Notifications[].Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Notifications[].Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Notifications[].Location.Department
  String
  Possible
  Department
- Media.Notifications[].Location.Room
  String
  Possible
  Room.
  Example: 136
Orders
- Orders[].ID
  String
  Possible
  ID of the order assigned by the placing system
- Orders[].Name
  String
  Possible
  Name of the order assigned by the placing system

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "New",
      "EventDateTime": "2022-01-19T15:30:49.955Z",
      "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"
         }
      ],
      "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,
         "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": {
      "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",
      "DirectAddressFrom": "[email protected]",
      "DirectAddressTo": "[email protected]",
      "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
            }
         }
      ]
   },
   "Orders": []
}

Replace

A Replace Media message is used to replace a document that was previously added to the patient's chart.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Media
- Meta.EventType
  String
  Reliable
  Required
  Replace
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List 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
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code 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
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient'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
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  A VisitNumber is highly recommended so that the document can be associated with a specific visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.Location
  Object
  Probable
  Location of the patient. This may be used for validation or to identify your application/device.
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
Media
- Media.FileType
  String
  Reliable
  Required
  File type of the document.
  E.g. PDF, JPG
- Media.FileName
  String
  Reliable
  Required
  Name of the file
- Media.FileContents
  String (Base64)
  Reliable
  Required
  Redox BLOB URI
- Media.DocumentType
  String
  Reliable
  Required
  Type of Document.
  This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
- Media.OriginalDocumentID
  String
  Possible
  Required
  ID of the document being replaced
- Media.DocumentID
  String
  Reliable
  Required
  Unique identifier for this document.
  This ID is required in order to update the document
- Media.DocumentDescription
  String
  Possible
  Descriptive label for this document.
- Media.CreationDateTime
  DateTime
  Possible
  This time represents when this media was created.
  ISO 8601 Format
- Media.ServiceDateTime
  DateTime
  Possible
  This time represents a clinical service timestamp with which this media is related.
  ISO 8601 Format
- Media.DirectAddressFrom
  String
  Possible
  The sender's Direct address, if one or both sides are using Direct messaging.
- Media.DirectAddressTo
  String
  Possible
  The recipient's Direct address, if one or both sides are using Direct messaging.
- Media.Provider.ID
  String
  Reliable
  Required
  ID of the Provider responsible for the document
- Media.Provider.IDType
  String
  Reliable
  ID type of the ID for the Provider responsible for the document
- Media.Provider.FirstName
  String
  Possible
  First name of the Provider responsible for the document
- Media.Provider.LastName
  String
  Possible
  Last name of the Provider responsible for the document
- Media.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Provider responsible for the document.
  e.g. MD, PhD
- Media.Provider.Address
  Object
  Possible
  Provider's address
- Media.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Media.Provider.Address.City
  String
  Possible
  City
- Media.Provider.Address.State
  String
  Possible
  State
- Media.Provider.Address.ZIP
  String
  Possible
  ZIP
- Media.Provider.Address.County
  String
  Possible
  County
- Media.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Provider.Location
  Object
  Possible
  Provider's location
- Media.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Provider.Location.Department
  String
  Possible
  Department
- Media.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Authenticated
  String
  Reliable
  The authenticated status of the document.
  True or False. If True, it is recommended to have Media.Authenticator filled out
- Media.Authenticator.ID
  String
  Reliable
  ID of the provider who authenticated the document.
  This ID is often required for Inpatient Visits.
- Media.Authenticator.IDType
  String
  Reliable
  ID type of the ID for the provider who authenticated the document
- Media.Authenticator.FirstName
  String
  Possible
  First name of the provider who authenticated the document
- Media.Authenticator.LastName
  String
  Possible
  Last name of the provider who authenticated the document
- Media.Authenticator.Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who authenticated the document.
  e.g. MD, PhD
- Media.Authenticator.Address
  Object
  Possible
  Provider's address
- Media.Authenticator.Address.StreetAddress
  String
  Possible
  Street address
- Media.Authenticator.Address.City
  String
  Possible
  City
- Media.Authenticator.Address.State
  String
  Possible
  State
- Media.Authenticator.Address.ZIP
  String
  Possible
  ZIP
- Media.Authenticator.Address.County
  String
  Possible
  County
- Media.Authenticator.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Authenticator.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Authenticator.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Authenticator.Location
  Object
  Possible
  Provider's location
- Media.Authenticator.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Authenticator.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Authenticator.Location.Department
  String
  Possible
  Department
- Media.Authenticator.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Availability
  String
  Reliable
  ValueSet
  Required
  Whether the document is available
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[]
  Array of Objects
  Reliable
  List of providers that should be notified when this document posts to the patient's chart
- Media.Notifications[].ID
  String
  Reliable
  ID of the provider who should be notified.
  This ID is often required for Inpatient Visits.
- Media.Notifications[].IDType
  String
  Reliable
  ID type of the ID for the provider who should be notified
- Media.Notifications[].FirstName
  String
  Possible
  First name of the provider who should be notified
- Media.Notifications[].LastName
  String
  Possible
  Last name of the provider who should be notified
- Media.Notifications[].Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who should be notified.
  e.g. MD, PhD
- Media.Notifications[].Address
  Object
  Possible
  Provider's address
- Media.Notifications[].Address.StreetAddress
  String
  Possible
  Street address
- Media.Notifications[].Address.City
  String
  Possible
  City
- Media.Notifications[].Address.State
  String
  Possible
  State
- Media.Notifications[].Address.ZIP
  String
  Possible
  ZIP
- Media.Notifications[].Address.County
  String
  Possible
  County
- Media.Notifications[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[].EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Notifications[].PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Notifications[].Location
  Object
  Possible
  Provider's location
- Media.Notifications[].Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Notifications[].Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Notifications[].Location.Department
  String
  Possible
  Department
- Media.Notifications[].Location.Room
  String
  Possible
  Room.
  Example: 136
Orders
- Orders[].ID
  String
  Possible
  ID of the order assigned by the placing system
- Orders[].Name
  String
  Possible
  Name of the order assigned by the placing system

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "Replace",
      "EventDateTime": "2022-01-19T15:30:49.955Z",
      "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"
         }
      ],
      "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,
         "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": {
      "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",
      "DirectAddressFrom": "[email protected]",
      "DirectAddressTo": "[email protected]",
      "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
            }
         }
      ]
   },
   "Orders": []
}

Delete

A Delete Media message is used to delete a document that was previously added to the patient's chart.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Media
- Meta.EventType
  String
  Reliable
  Required
  Delete
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List 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
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code 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
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient'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
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
Visit
- Visit.VisitNumber
  String
  Reliable
  Visit Number.
  A VisitNumber is highly recommended so that the document can be associated with a specific visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.Location
  Object
  Probable
  Location of the patient. This may be used for validation or to identify your application/device.
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
Media
- Media.FileType
  String
  Reliable
  Required
  File type of the document.
  E.g. PDF, JPG
- Media.FileName
  String
  Reliable
  Required
  Name of the file
- Media.DocumentType
  String
  Reliable
  Required
  Type of Document.
  This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
- Media.DocumentID
  String
  Reliable
  Required
  Unique identifier for this document.
  This ID is required in order to update the document
- Media.DocumentDescription
  String
  Possible
  Descriptive label for this document.
- Media.CreationDateTime
  DateTime
  Possible
  This time represents when this media was created.
  ISO 8601 Format
- Media.ServiceDateTime
  DateTime
  Possible
  This time represents a clinical service timestamp with which this media is related.
  ISO 8601 Format
- Media.DirectAddressFrom
  String
  Possible
  The sender's Direct address, if one or both sides are using Direct messaging.
- Media.DirectAddressTo
  String
  Possible
  The recipient's Direct address, if one or both sides are using Direct messaging.
- Media.Provider.ID
  String
  Reliable
  Required
  ID of the Provider responsible for the document
- Media.Provider.IDType
  String
  Reliable
  ID type of the ID for the Provider responsible for the document
- Media.Provider.FirstName
  String
  Possible
  First name of the Provider responsible for the document
- Media.Provider.LastName
  String
  Possible
  Last name of the Provider responsible for the document
- Media.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Provider responsible for the document.
  e.g. MD, PhD
- Media.Provider.Address
  Object
  Possible
  Provider's address
- Media.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Media.Provider.Address.City
  String
  Possible
  City
- Media.Provider.Address.State
  String
  Possible
  State
- Media.Provider.Address.ZIP
  String
  Possible
  ZIP
- Media.Provider.Address.County
  String
  Possible
  County
- Media.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Provider.Location
  Object
  Possible
  Provider's location
- Media.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Provider.Location.Department
  String
  Possible
  Department
- Media.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Authenticated
  String
  Reliable
  The authenticated status of the document.
  True or False. If True, it is recommended to have Media.Authenticator filled out
- Media.Authenticator.ID
  String
  Reliable
  ID of the provider who authenticated the document.
  This ID is often required for Inpatient Visits.
- Media.Authenticator.IDType
  String
  Reliable
  ID type of the ID for the provider who authenticated the document
- Media.Authenticator.FirstName
  String
  Possible
  First name of the provider who authenticated the document
- Media.Authenticator.LastName
  String
  Possible
  Last name of the provider who authenticated the document
- Media.Authenticator.Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who authenticated the document.
  e.g. MD, PhD
- Media.Authenticator.Address
  Object
  Possible
  Provider's address
- Media.Authenticator.Address.StreetAddress
  String
  Possible
  Street address
- Media.Authenticator.Address.City
  String
  Possible
  City
- Media.Authenticator.Address.State
  String
  Possible
  State
- Media.Authenticator.Address.ZIP
  String
  Possible
  ZIP
- Media.Authenticator.Address.County
  String
  Possible
  County
- Media.Authenticator.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Authenticator.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Authenticator.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Authenticator.Location
  Object
  Possible
  Provider's location
- Media.Authenticator.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Authenticator.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Authenticator.Location.Department
  String
  Possible
  Department
- Media.Authenticator.Location.Room
  String
  Possible
  Room.
  Example: 136
- Media.Availability
  String
  Reliable
  ValueSet
  Required
  Whether the document is available
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[]
  Array of Objects
  Reliable
  List of providers that should be notified when this document posts to the patient's chart
- Media.Notifications[].ID
  String
  Reliable
  ID of the provider who should be notified.
  This ID is often required for Inpatient Visits.
- Media.Notifications[].IDType
  String
  Reliable
  ID type of the ID for the provider who should be notified
- Media.Notifications[].FirstName
  String
  Possible
  First name of the provider who should be notified
- Media.Notifications[].LastName
  String
  Possible
  Last name of the provider who should be notified
- Media.Notifications[].Credentials[]
  Array of Strings
  Possible
  List of credentials for the provider who should be notified.
  e.g. MD, PhD
- Media.Notifications[].Address
  Object
  Possible
  Provider's address
- Media.Notifications[].Address.StreetAddress
  String
  Possible
  Street address
- Media.Notifications[].Address.City
  String
  Possible
  City
- Media.Notifications[].Address.State
  String
  Possible
  State
- Media.Notifications[].Address.ZIP
  String
  Possible
  ZIP
- Media.Notifications[].Address.County
  String
  Possible
  County
- Media.Notifications[].Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Media.Notifications[].EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Media.Notifications[].PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Media.Notifications[].Location
  Object
  Possible
  Provider's location
- Media.Notifications[].Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Media.Notifications[].Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Media.Notifications[].Location.Department
  String
  Possible
  Department
- Media.Notifications[].Location.Room
  String
  Possible
  Room.
  Example: 136
Orders
- Orders[].ID
  String
  Possible
  ID of the order assigned by the placing system
- Orders[].Name
  String
  Possible
  Name of the order assigned by the placing system

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "Delete",
      "EventDateTime": "2022-01-19T15:30:49.955Z",
      "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"
         }
      ],
      "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,
         "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": {
      "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",
      "DirectAddressFrom": "[email protected]",
      "DirectAddressTo": "[email protected]",
      "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
            }
         }
      ]
   },
   "Orders": []
}

Query

BETADATA ON DEMAND ENABLED

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

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Media
- Meta.EventType
  String
  Reliable
  Required
  Query
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List 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
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code 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
  Reliable
  Array 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
  Reliable
  List 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
  Reliable
  ID of the Patient
- Patients[].Identifiers[].IDType
  String
  Reliable
  ID Type for the corresponding ID of this patient (ie. MRN, EHRID)
VisitNumbers
- VisitNumbers[]
  Array of Strings
  Reliable
  Array 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
  Reliable
  Array of document types to query on.
  The type of media to retrieve (E.g. Consent Form, Treatment Plan)
DocumentIDs
- DocumentIDs[]
  Array of Strings
  Reliable
  Array of document identifiers to query on.

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "Query",
      "EventDateTime": "2022-01-19T15:30:49.955Z",
      "Test": true,
      "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
   },
   "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"
   ]
}

QueryResponse

BETADATA ON DEMAND ENABLED

This is the response format for a Media Query.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Media
- Meta.EventType
  String
  Reliable
  Required
  QueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List 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
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code 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
  Reliable
  List of IDs and ID types that identify the patient
- Media[].Patient.Identifiers[].ID
  String
  Reliable
  ID for the patient
- Media[].Patient.Identifiers[].IDType
  String
  Reliable
  Type of ID.
  E.g. MRN, EPI
- Media[].Visit.VisitNumber
  String
  Reliable
  Visit Number.
  A VisitNumber is highly recommended so that the document can be associated with a specific visit
- Media[].FileType
  String
  Reliable
  File type of the document.
  E.g. PDF, JPG
- Media[].FileName
  String
  Reliable
  Name of the file
- Media[].FileContents
  String (Base64)
  Reliable
  Redox BLOB URI
- Media[].DocumentType
  String
  Reliable
  Type of Document.
  This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)
- Media[].DocumentID
  String
  Reliable
  Unique identifier for this document.
  This ID is required in order to update the document
- Media[].DocumentDescription
  String
  Possible
  Descriptive label for this document.
- Media[].CreationDateTime
  DateTime
  Possible
  This time represents when this media was created.
  ISO 8601 Format
- Media[].ServiceDateTime
  DateTime
  Possible
  This time represents a clinical service timestamp with which this media is related.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "QueryResponse",
      "EventDateTime": "2022-01-19T15:30:49.955Z",
      "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"
         }
      ],
      "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"
      }
   ]
}

Media

Newlink

Fields

Meta

Patient

Visit

Media

Orders

Replacelink

Fields

Meta

Patient

Visit

Media

Orders

Deletelink

Fields

Meta

Patient

Visit

Media

Orders

Querylink

Fields

Meta

Patients

VisitNumbers

DocumentTypes

DocumentIDs

QueryResponselink

Fields

Meta

Media

New

Replace

Delete

Query

QueryResponse