# Enrichment NormalizationQueryResponse

Send data to a third party for processing. 

This data model has event types that allow you to:

- submit code entries for processing; or
- receive processed code entries.

Receive submitted code entries with the matching code values from related code sets. Each returned match includes a confidence score denoting the certainty of the match. 

Status: Beta, Developer preview

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Enrichment |
| `Meta.EventType` | string | Yes | NormalizationQueryResponse |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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` | Array of object | Yes | A list of normalized entries that were submitted with the NormalizationQuery. |
| `Entries[].Category` | string | Yes | The category of values for this normalization entry. *One of the following: Problem* |
| `Entries[].Status` | string | Yes | The outcome of this specific entry's normalization. *One of the following: Success, Error* |
| `Entries[].Transaction` | object | Yes | Contains details about the vendor that performed the enrichment. |
| `Entries[].Transaction.VendorID` | string | Yes | The identifier of the third-party vendor that processed the enrichment request. |
| `Entries[].Transaction.ID` | string | Yes | The identifier of the specific enrichment transaction, which is generated by the third-party vendor.       You can use this identifier to reconcile transactions (e.g., for billing review).       Note that multiple entries might have the same transaction identifier if a vendor supports batch enrichment. |
| `Entries[].Submitted` | object | Yes | A copy of the entry input data provided in your Normalization Query. |
| `Entries[].Submitted.Category` | string | Yes | The category of values in which to find this normalization entry. *Categories currently supported: Problem. This is an unmodified copy of the value submitted in your Normalization Query.* |
| `Entries[].Submitted.EntryID` | string or null | No | This is an unmodified copy of the value submitted in the NormalizationQuery. If you didn't provide an ID, Redox generates one for you. * This is an unmodified copy of the value submitted in your Normalization Query.* |
| `Entries[].Submitted.Code` | string or null | No | 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.  This is an unmodified copy of the value submitted in your Normalization Query.* |
| `Entries[].Submitted.Codeset` | string or null | No | 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.  This is an unmodified copy of the value submitted in your Normalization Query.* Value set 91cd6488-d157-4d2c-980d-dd38806872f2: ICD-10-CM, ICD-9-CM, SNOMED CT |
| `Entries[].Submitted.Description` | string or null | No | 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.  This is an unmodified copy of the value submitted in your Normalization Query.* |
| `Entries[].Normalization` | Array of object | No | The output of the normalization transaction.       If normalization results in an error, this array contains the error information.       If normalization results in a success, this array contains the normalized entry data. |
| `Entries[].Normalization[].LexicalReference` | object | No | The principal code value that was matched with the input data provided for this entry. |
| `Entries[].Normalization[].LexicalReference.Code` | string or null | No | The value of the normalized match for the submitted code value. |
| `Entries[].Normalization[].LexicalReference.Name` | string or null | No | The name of the normalized match of the submitted code value. |
| `Entries[].Normalization[].LexicalReference.DefaultCode` | string or null | No | The value of the default variant of the normalized match for the submitted code value. |
| `Entries[].Normalization[].LexicalReference.DefaultName` | string or null | No | The name or of the default variant of the normalized match for the submitted code value. |
| `Entries[].Normalization[].Score` | object | No | The quantified confidence that the Lexical Reference value matches the input data provided for this entry. |
| `Entries[].Normalization[].Score.Value` | number or null | No | The quality/certainty score for the Lexical Reference match, between `0` and `1`: an exact match has a score value of `1`. |
| `Entries[].Normalization[].Score.Description` | string or null | No | The description of the confidence score for the normalization. A score of 1 will have a description of Exact. |
| `Entries[].Normalization[].Matches` | Array of object | No | Any related coded values associated with the matched Lexical Reference value, collected by code system. |
| `Entries[].Normalization[].Matches[].Codeset` | string or null | No | Coding system to which the related codes belong (e.g. ICD-10-CM, ICD-9-CM, SNOMED CT) |
| `Entries[].Normalization[].Matches[].Status` | string or null | No | The outcome of matching the lexical reference code to this specific Code Set. *One of the following: Success, Not Codeable, Insufficient Data* |
| `Entries[].Normalization[].Matches[].Codes` | Array of object | No | The collection of related coded values within this Match's code set, if matching was successful. |
| `Entries[].Normalization[].Matches[].Codes[].Code` | string or null | No | The code value in the indicated code set in the normalization category. |
| `Entries[].Normalization[].Matches[].Codes[].MatchPriority` | string or null | No | Indicates the priority for this match (e.g. Preferred Primary or Preferred). |
| `Entries[].Normalization[].Matches[].Codes[].Variants` | Array of object | No | A collection of variants for the code value; for example, multiple titles might apply to the same code. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].Title` | string or null | No | A specific title of the code value variant. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].TitleStatus` | string or null | No | The status of this title for the code value variant, if a status is applicable. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].TitleType` | string or null | No | If the title of this variant can be categorized, this is the type description. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].ExtendedProperties` | Array of object | No | The collection of any metadata properties about this specific code variant. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].ExtendedProperties[].Category` | string or null | No | The category name of this set of extended properties of this variant. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].ExtendedProperties[].Properties` | Array of object | No | The collection of extended properties within the given category. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].ExtendedProperties[].Properties[].Property` | string or null | No | The extended property name or code within the given category. |
| `Entries[].Normalization[].Matches[].Codes[].Variants[].ExtendedProperties[].Properties[].Value` | string or null | No | The value of the extended property within the given category. |
| `Entries[].Error` | object | No | If enrichment operation results in an error, this object contains the error details.       If the operation results in a success, this object is null. Note that it's possible for some operations in a request to succeed while others fail. |
| `Entries[].Error.Code` | string or null | No | Contains the error code as defined by the third-party vendor. |
| `Entries[].Error.Message` | string or null | No | Describes the error that disrupted the enrichment operation. |

## Example

```json
{
  "Meta": {
    "DataModel": "Enrichment",
    "EventType": "NormalizationQueryResponse",
    "EventDateTime": "2026-11-20T22:18:53.621Z",
    "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"
      }
    ],
    "FacilityCode": null
  },
  "Entries": [
    {
      "Category": "Problem",
      "Status": "Success",
      "Transaction": {
        "VendorID": "IMO",
        "ID": "d43e78d1-ff88-4ea8-bf23-8cf191517ac5"
      },
      "Submitted": {
        "Category": "Problem",
        "EntryID": "My-Normalization-943a94d1-0a85-4876-bfa0-f3dba4960a14",
        "Code": "E11.29",
        "Codeset": "ICD-10-CM",
        "Description": null
      },
      "Normalization": [
        {
          "LexicalReference": {
            "Code": "E11.29",
            "Name": "Uncontrolled type 2 diabetes with renal manifestation",
            "DefaultCode": "E11.65",
            "DefaultName": "Type 2 diabetes mellitus with hyperglycemia"
          },
          "Score": {
            "Value": 1,
            "Description": "Exact"
          },
          "Matches": [
            {
              "Codeset": "ICD-10-CM",
              "Status": "Success",
              "Codes": [
                {
                  "Code": "E11.65",
                  "MatchPriority": "Preferred primary",
                  "Variants": [
                    {
                      "Title": "Type 2 diabetes mellitus with hyperglycemia",
                      "TitleStatus": null,
                      "TitleType": null,
                      "ExtendedProperties": [
                        {
                          "Category": "CCSR",
                          "Properties": [
                            {
                              "Property": "END",
                              "Value": "Endocrine, nutritional and metabolic diseases"
                            }
                          ]
                        },
                        {
                          "Category": "HCC",
                          "Properties": [
                            {
                              "Property": "HCC Model Category",
                              "Value": "18"
                            },
                            {
                              "Property": "Community, Non-Dual-Aged",
                              "Value": "0.302"
                            },
                            {
                              "Property": "Community, Non-Dual-Disabled",
                              "Value": "0.351"
                            },
                            {
                              "Property": "Community, Full Benefit, Dual Aged",
                              "Value": "0.340"
                            },
                            {
                              "Property": "CCommunity, Full Benefit, Dual-Disabled",
                              "Value": "0.423"
                            },
                            {
                              "Property": "Community, Partial Benefit, Dual Aged",
                              "Value": "0.087"
                            },
                            {
                              "Property": "Community, Partial Benefit, Dual-Disabled",
                              "Value": "0.373"
                            },
                            {
                              "Property": "Institutional",
                              "Value": "0.440"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "Codeset": "SNOMED CT",
              "Status": "Success",
              "Codes": [
                {
                  "Code": "420279001",
                  "MatchPriority": "Preferred",
                  "Variants": [
                    {
                      "Title": "Renal disorder due to type 2 diabetes mellitus",
                      "TitleStatus": null,
                      "TitleType": null,
                      "ExtendedProperties": []
                    }
                  ]
                },
                {
                  "Code": "44054006",
                  "MatchPriority": "Preferred",
                  "Variants": [
                    {
                      "Title": "Diabetes mellitus type 2 (disorder)",
                      "TitleStatus": null,
                      "TitleType": null,
                      "ExtendedProperties": []
                    }
                  ]
                }
              ]
            },
            {
              "Codeset": "ICD-9-CM",
              "Status": "Success",
              "Codes": [
                {
                  "Code": "250.00",
                  "MatchPriority": "Preferred",
                  "Variants": [
                    {
                      "Title": "Diabetes mellitus without mention of complication, type ii ",
                      "TitleStatus": null,
                      "TitleType": null,
                      "ExtendedProperties": []
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "Error": {
        "Code": null,
        "Message": null
      }
    }
  ]
}
```
