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.

Newlink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • 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.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

    • 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

    • 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

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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

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

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

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

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • 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

      Country

    • 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

  • 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.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.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

      Country

    • 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.Provider.PhoneNumber.Office

      String

      Possible

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

    • Media.Authenticated

      String

      Reliable

      The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

    • Media.Authenticator.ID

      String

      Reliable

      ID of the provider who authenticated the document. This ID is 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

      Country

    • 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.Authenticator.PhoneNumber.Office

      String

      Possible

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

    • Media.Availability

      String

      Reliable
      Required

      Whether the document is available. Either: Available or Unavailable

    • 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 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

      Country

    • 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

    • Media.Notifications[].PhoneNumber.Office

      String

      Possible

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

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "New",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
         },
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Timothy",
         "MiddleName": "Paul",
         "LastName": "Bixby",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "Asian",
         "IsHispanic": 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"
   },
   "Media": {
      "FileType": "PDF",
      "FileName": "SamplePDF",
      "FileContents": "<...base 64 file contents...>",
      "DocumentType": "Empty File",
      "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
      "CreationDateTime": "2017-06-22T19:30:04.387Z",
      "ServiceDateTime": "2017-06-22T17:00:00.387Z",
      "Provider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "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
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085559999"
            }
         },
         {
            "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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+13145557777"
            }
         }
      ]
   }
}

Replacelink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Replace

    • 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.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

    • 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

    • 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

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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

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

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

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

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • 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

      Country

    • 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

  • 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.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.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.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

      Country

    • 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.Provider.PhoneNumber.Office

      String

      Possible

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

    • Media.Authenticated

      String

      Reliable

      The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

    • Media.Authenticator.ID

      String

      Reliable

      ID of the provider who authenticated the document. This ID is 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

      Country

    • 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.Authenticator.PhoneNumber.Office

      String

      Possible

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

    • Media.Availability

      String

      Reliable
      Required

      Whether the document is available. Either: Available or Unavailable

    • 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 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

      Country

    • 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

    • Media.Notifications[].PhoneNumber.Office

      String

      Possible

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

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "Replace",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
         },
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Timothy",
         "MiddleName": "Paul",
         "LastName": "Bixby",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "Asian",
         "IsHispanic": 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"
   },
   "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",
      "CreationDateTime": "2017-06-22T19:30:04.387Z",
      "ServiceDateTime": "2017-06-22T17:00:00.387Z",
      "Provider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "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
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085559999"
            }
         },
         {
            "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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+13145557777"
            }
         }
      ]
   }
}

Deletelink

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Delete

    • 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.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

    • 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

    • 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

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • 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

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

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

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

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • 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

      Country

    • 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

  • 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.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.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

      Country

    • 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.Provider.PhoneNumber.Office

      String

      Possible

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

    • Media.Authenticated

      String

      Reliable

      The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

    • Media.Authenticator.ID

      String

      Reliable

      ID of the provider who authenticated the document. This ID is 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

      Country

    • 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.Authenticator.PhoneNumber.Office

      String

      Possible

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

    • Media.Availability

      String

      Reliable
      Required

      Whether the document is available. Either: Available or Unavailable

    • 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 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

      Country

    • 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

    • Media.Notifications[].PhoneNumber.Office

      String

      Possible

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

{
   "Meta": {
      "DataModel": "Media",
      "EventType": "Delete",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
         },
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Timothy",
         "MiddleName": "Paul",
         "LastName": "Bixby",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "Asian",
         "IsHispanic": 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"
   },
   "Media": {
      "FileType": "PDF",
      "FileName": "SamplePDF",
      "DocumentType": "Empty File",
      "DocumentID": "b169267c-10c9-4fe3-91ae-9ckf5703e90l",
      "CreationDateTime": "2017-06-22T19:30:04.387Z",
      "ServiceDateTime": "2017-06-22T17:00:00.387Z",
      "Provider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "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
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": 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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085559999"
            }
         },
         {
            "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"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+13145557777"
            }
         }
      ]
   }
}