Enrichment

Request Body Schema

• Meta

  required, object

  • DataModel

    required, string

    Reliable

    Enrichment
  • EventType

    required, string

    Reliable

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

  required, Array of object

  A list of entries to be normalized. The maximum number of entries that can be included is 100.

  • Category

    required, string

    Reliable

    The category of values in which to find this normalization entry.
    Categories currently supported: Problem.
  • EntryID

    string, null

    Possible

    The identifier of the specific entry to be normalized. If not provided, Redox generates an identifier to populate this field in the NormalizationQueryResponse so that you can match the normalized entry to the submitted entry.
  • Code

    string, null

    Probable

    Code for the value to be normalized by the third-party vendor.
    *You must include either code value or description, or you can provide both. *
  • Codeset

    string, null

    Probable

    Value Set

    Code set used to identify the value to be normalized by the third-party vendor.
    *For example: ICD-10-CM, ICD-9-CM, SNOMED CT. *

    Show Values

    Value
    ICD-10-CM
    ICD-9-CM
    SNOMED CT
  • Description

    string, null

    Probable

    Description of the value to be normalized by the third-party vendor.
    *You must include either code value or description, or you can provide both. *