Home
API reference
Redox Data Models
Media
New

Media

This data model allows you to exchange files (e.g., JPEG, PDF, WAV) like photos, videos, and audio recordings, as well as imaging and documents to or from a patient's chart.

​You can also send files or documents with the Notes and Results data models. Learn how to send a file with different data models.

This data model has event types that allow you to:

  • save, replace, or delete a media document; or
  • query for and receive media documents.

New

Save a new document to a patient's chart.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Media

    • EventType
      required, string
      Reliable

      New

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      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
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

        Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

        Date and Time the patient was proclaimed deceased.
        ISO 8601 Format

      • PhoneNumber
        object
        • Home
          string, null
          Probable

          Patient's home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Probable

          Patient's office phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Mobile
          string, null
          Probable

          Patient's mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

        Patient's primary spoken language.
        In ISO 639-1 alpha values (e.g. 'en'). Supported Values

      • Citizenship
        Array of string

        Patient's nation(s) of citizenship.
        In ISO 3166 alpha 2 format (e.g. 'US').

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

  • Media
    required, object
    • FileType
      required, string
      Reliable

      Identifies the format of the file (e.g., PDF, JPG).

    • FileName
      required, string
      Reliable

      Displays the name of the file.

    • FileContents
      required, string
      Reliable

      Contains the encoded base64 string with the contents of the file.

    • DocumentType
      required, string
      Reliable

      Classifies the type of document (e.g., consent form, treatment plan).

    • DocumentID
      required, string
      Reliable

      Contains the unique identifier for the document. You must have the document ID to update the document later.

    • Provider
      required, object
      • ID
        required, string
        Reliable

        ID of the Identifies the provider that's responsible for the document.

      • IDType
        string, null
        Reliable

        ID type of the ID for the Identifies the provider that's responsible for the document.

      • FirstName
        string, null
        Possible

        First name of the Identifies the provider that's responsible for the document.

      • LastName
        string, null
        Possible

        Last name of the Identifies the provider that's responsible for the document.

      • Credentials
        Array of string

        List of credentials for the Identifies the provider that's responsible for the document.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Availability
      required, string
      Reliable
      Value Set

      Indicates whether the document is available for use. This should be populated with either Available or Unavailable.
      Not supported with data on demand.

    • DocumentDescription
      string, null
      Possible

      Contains a descriptive label for the document.

    • CreationDateTime
      string, null
      Possible

      Displays the timestamp for when the file was created.
      ISO 8601 Format

    • ServiceDateTime
      string, null
      Possible

      Displays the timestamp for when the related clinical service occurred.
      ISO 8601 Format

    • DirectAddressFrom
      string, null
      Possible

      Contains the sender's Direct address if one or both sides are using Direct messaging.
      Not supported with data on demand.

    • DirectAddressTo
      string, null
      Possible

      Contains the recipient's Direct address if one or both sides are using Direct messaging.
      Not supported with data on demand.

    • Authenticated
      string, null
      Reliable

      Displays the authenticated status of the document, which can be either True or False. If True, we recommend populating the related Media.Authenticator field.
      Not supported with data on demand.

    • Authenticator
      object
      • ID
        string, null
        Reliable

        ID of the provider who authenticated the document.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Reliable

        ID type of the ID for the provider who authenticated the document

      • FirstName
        string, null
        Possible

        First name of the provider who authenticated the document

      • LastName
        string, null
        Possible

        Last name of the provider who authenticated the document

      • Credentials
        Array of string

        List of credentials for the provider who authenticated the document.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Notifications
      Array of object

      Contains a list of providers that should be notified when the document posts to the patient's chart.
      Not supported with data on demand.

      • ID
        string, null
        Reliable

        ID of the provider who should be notified.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Reliable

        ID type of the ID for the provider who should be notified

      • FirstName
        string, null
        Possible

        First name of the provider who should be notified

      • LastName
        string, null
        Possible

        Last name of the provider who should be notified

      • Credentials
        Array of string

        List of credentials for the provider who should be notified.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

  • Visit
    object
    • VisitNumber
      string, null
      Reliable

      Displays a unique identifier for the patient visit. We highly recommend including a visit number so the document can be associated with a specific visit.

    • AccountNumber
      string, null
      Possible

      Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
      Not supported with data on demand.

    • Location
      object

      Displays the location of the patient visit. This may be used to validate or to identify your application/device.

      • Type
        string, null
        Probable

        Type of location.
        Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

      • Facility
        string, null
        Probable

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Probable

          An ID specific to this facility

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Probable

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Probable

          An ID specific to this department

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Probable

        Room.
        Example: 136

      • Bed
        string, null
        Probable

        Bed.
        Example: B

  • Orders
    Array of object
    • ID
      string, null
      Possible

      Contains the unique identifier of the order request, which is assigned by the system that placed the order.

    • Name
      string, null
      Possible

      Displays the name of the order, which is assigned by the system that placed the order.

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Media",
4
    "EventType": "New",
5
    "EventDateTime": "2024-11-20T14:08:29.777Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "0000000001",
29
        "IDType": "MR"
30
      },
31
      {
32
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
33
        "IDType": "EHRID"
34
      },
35
      {
36
        "ID": "a1d4ee8aba494ca",
37
        "IDType": "NIST"
38
      }
39
    ],
40
    "Demographics": {
41
      "FirstName": "Timothy",
42
      "MiddleName": "Paul",
43
      "LastName": "Bixby",
44
      "DOB": "2008-01-06",
45
      "SSN": "101-01-0001",
46
      "Sex": "Male",
47
      "Race": "White",
48
      "IsHispanic": null,
49
      "Religion": null,
50
      "MaritalStatus": "Single",
51
      "IsDeceased": null,
52
      "DeathDateTime": null,
53
      "PhoneNumber": {
54
        "Home": "+18088675301",
55
        "Office": null,
56
        "Mobile": null
57
      },
58
      "EmailAddresses": [],
59
      "Language": "en",
60
      "Citizenship": [],
61
      "Address": {
62
        "StreetAddress": "4762 Hickory Street",
63
        "City": "Monroe",
64
        "State": "WI",
65
        "ZIP": "53566",
66
        "County": "Green",
67
        "Country": "US"
68
      }
69
    },
70
    "Notes": []
71
  },
72
  "Visit": {
73
    "VisitNumber": "1234",
74
    "AccountNumber": null,
75
    "Location": {
76
      "Type": null,
77
      "Facility": null,
78
      "FacilityIdentifiers": [],
79
      "Department": null,
80
      "DepartmentIdentifiers": [],
81
      "Room": null,
82
      "Bed": null
83
    }
84
  },
85
  "Media": {
86
    "FileType": "PDF",
87
    "FileName": "SamplePDF",
88
    "FileContents": "<...base 64 file contents...>",
89
    "DocumentType": "Empty File",
90
    "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
91
    "DocumentDescription": null,
92
    "CreationDateTime": "2017-06-22T19:30:04.387Z",
93
    "ServiceDateTime": "2017-06-22T17:00:00.387Z",
94
    "DirectAddressFrom": "pat.granite@direct.redoxengine.com",
95
    "DirectAddressTo": "john.slate@direct.redoxengine.com",
96
    "Provider": {
97
      "ID": "4356789876",
98
      "IDType": "NPI",
99
      "FirstName": "Pat",
100
      "LastName": "Granite",
101
      "Credentials": [
102
        "MD"
103
      ],
104
      "Address": {
105
        "StreetAddress": "123 Main St.",
106
        "City": "Madison",
107
        "State": "WI",
108
        "ZIP": "53703",
109
        "County": "Dane",
110
        "Country": "USA"
111
      },
112
      "EmailAddresses": [],
113
      "PhoneNumber": {
114
        "Office": "+16085551234"
115
      },
116
      "Location": {
117
        "Type": null,
118
        "Facility": null,
119
        "FacilityIdentifiers": [],
120
        "Department": null,
121
        "DepartmentIdentifiers": [],
122
        "Room": null
123
      }
124
    },
125
    "Authenticated": "False",
126
    "Authenticator": {
127
      "ID": null,
128
      "IDType": null,
129
      "FirstName": null,
130
      "LastName": null,
131
      "Credentials": [],
132
      "Address": {
133
        "StreetAddress": null,
134
        "City": null,
135
        "State": null,
136
        "ZIP": null,
137
        "County": null,
138
        "Country": null
139
      },
140
      "EmailAddresses": [],
141
      "PhoneNumber": {
142
        "Office": null
143
      },
144
      "Location": {
145
        "Type": null,
146
        "Facility": null,
147
        "FacilityIdentifiers": [],
148
        "Department": null,
149
        "DepartmentIdentifiers": [],
150
        "Room": null
151
      }
152
    },
153
    "Availability": "Unavailable",
154
    "Notifications": [
155
      {
156
        "ID": "2434534567",
157
        "IDType": "NPI",
158
        "FirstName": "Sharon",
159
        "LastName": "Chalk",
160
        "Credentials": [
161
          "MD",
162
          "PhD"
163
        ],
164
        "Address": {
165
          "StreetAddress": "312 Maple Dr. Suite 400",
166
          "City": "Verona",
167
          "State": "WI",
168
          "ZIP": "53593",
169
          "County": "Dane",
170
          "Country": "USA"
171
        },
172
        "EmailAddresses": [],
173
        "PhoneNumber": {
174
          "Office": "+16085559999"
175
        },
176
        "Location": {
177
          "Type": null,
178
          "Facility": null,
179
          "FacilityIdentifiers": [],
180
          "Department": null,
181
          "DepartmentIdentifiers": [],
182
          "Room": null
183
        }
184
      },
185
      {
186
        "ID": "8263749385",
187
        "IDType": "NPI",
188
        "FirstName": "Jim",
189
        "LastName": "Mica",
190
        "Credentials": [
191
          "RN"
192
        ],
193
        "Address": {
194
          "StreetAddress": "5235 Kennedy Ave.",
195
          "City": "Creve Cour",
196
          "State": "MO",
197
          "ZIP": "63141",
198
          "County": "Saint Louis",
199
          "Country": "USA"
200
        },
201
        "EmailAddresses": [],
202
        "PhoneNumber": {
203
          "Office": "+13145557777"
204
        },
205
        "Location": {
206
          "Type": null,
207
          "Facility": null,
208
          "FacilityIdentifiers": [],
209
          "Department": null,
210
          "DepartmentIdentifiers": [],
211
          "Room": null
212
        }
213
      }
214
    ]
215
  },
216
  "Orders": []
217
}