Enrichment

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.

NormalizationQueryResponse

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.

Beta

Dev preview

Request Body Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Enrichment
- EventType
  required, string
  Reliable
  NormalizationQueryResponse
- 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 normalized entries that were submitted with the NormalizationQuery.
- Category
  required, string
  Reliable
  The category of values for this normalization entry.
  One of the following: Problem
- Status
  required, string
  Reliable
  The outcome of this specific entry's normalization.
  One of the following: Success, Error
- Transaction
  required, object
  Contains details about the vendor that performed the enrichment.
  VendorID
  required, string
  Reliable
  The identifier of the third-party vendor that processed the enrichment request.
  ID
  required, string
  Reliable
  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.
- Submitted
  required, object
  A copy of the entry input data provided in your Normalization Query.
  Category
  required, string
  Reliable
  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.
  EntryID
  string, null
  Possible
  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.*
  
  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. This is an unmodified copy of the value submitted in your Normalization Query.
  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. This is an unmodified copy of the value submitted in your Normalization Query.
  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. This is an unmodified copy of the value submitted in your Normalization Query.
- Normalization
  Array of object
  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.
  LexicalReference
  object
  The principal code value that was matched with the input data provided for this entry.
  Code
  string, null
  Reliable
  The value of the normalized match for the submitted code value.
  Name
  string, null
  Reliable
  The name of the normalized match of the submitted code value.
  DefaultCode
  string, null
  Probable
  The value of the default variant of the normalized match for the submitted code value.
  DefaultName
  string, null
  Probable
  The name or of the default variant of the normalized match for the submitted code value.
  Score
  object
  The quantified confidence that the Lexical Reference value matches the input data provided for this entry.
  Value
  number, null
  Reliable
  The quality/certainty score for the Lexical Reference match, between 0 and 1: an exact match has a score value of 1.
  Description
  string, null
  Reliable
  The description of the confidence score for the normalization. A score of 1 will have a description of Exact.
  Matches
  Array of object
  Any related coded values associated with the matched Lexical Reference value, collected by code system.
  Codeset
  string, null
  Reliable
  Coding system to which the related codes belong (e.g. ICD-10-CM, ICD-9-CM, SNOMED CT)
  Status
  string, null
  Reliable
  The outcome of matching the lexical reference code to this specific Code Set.
  One of the following: Success, Not Codeable, Insufficient Data
  Codes
  Array of object
  The collection of related coded values within this Match's code set, if matching was successful.
  Code
  string, null
  Reliable
  The code value in the indicated code set in the normalization category.
  MatchPriority
  string, null
  Reliable
  Indicates the priority for this match (e.g. Preferred Primary or Preferred).
  Variants
  Array of object
  A collection of variants for the code value; for example, multiple titles might apply to the same code.
  Title
  string, null
  Reliable
  A specific title of the code value variant.
  TitleStatus
  string, null
  Probable
  The status of this title for the code value variant, if a status is applicable.
  TitleType
  string, null
  Probable
  If the title of this variant can be categorized, this is the type description.
  ExtendedProperties
  Array of object
  The collection of any metadata properties about this specific code variant.
  Category
  string, null
  Probable
  The category name of this set of extended properties of this variant.
  Properties
  Array of object
  The collection of extended properties within the given category.
  Property
  string, null
  Probable
  The extended property name or code within the given category.
  Value
  string, null
  Probable
  The value of the extended property within the given category.
- Error
  object
  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.
  Code
  string, null
  Probable
  Contains the error code as defined by the third-party vendor.
  Message
  string, null
  Probable
  Describes the error that disrupted the enrichment operation.

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

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Enrichment",
4
    "EventType": "NormalizationQueryResponse",
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
  "Entries": [
26
    {
27
      "Category": "Problem",
28
      "Status": "Success",
29
      "Transaction": {
30
        "VendorID": "IMO",
31
        "ID": "eb3987cd-3a13-4aad-9774-598a3e1f2618"
32
      },
33
      "Submitted": {
34
        "Category": "Problem",
35
        "EntryID": "My-Normalization-fe29fb07-d8fd-493a-8018-2b82c6c7ad28",
36
        "Code": "E11.29",
37
        "Codeset": "ICD-10-CM",
38
        "Description": null
39
      },
40
      "Normalization": [
41
        {
42
          "LexicalReference": {
43
            "Code": "E11.29",
44
            "Name": "Uncontrolled type 2 diabetes with renal manifestation",
45
            "DefaultCode": "E11.65",
46
            "DefaultName": "Type 2 diabetes mellitus with hyperglycemia"
47
          },
48
          "Score": {
49
            "Value": 1,
50
            "Description": "Exact"
51
          },
52
          "Matches": [
53
            {
54
              "Codeset": "ICD-10-CM",
55
              "Status": "Success",
56
              "Codes": [
57
                {
58
                  "Code": "E11.65",
59
                  "MatchPriority": "Preferred primary",
60
                  "Variants": [
61
                    {
62
                      "Title": "Type 2 diabetes mellitus with hyperglycemia",
63
                      "TitleStatus": null,
64
                      "TitleType": null,
65
                      "ExtendedProperties": [
66
                        {
67
                          "Category": "CCSR",
68
                          "Properties": [
69
                            {
70
                              "Property": "END",
71
                              "Value": "Endocrine, nutritional and metabolic diseases"
72
                            }
73
                          ]
74
                        },
75
                        {
76
                          "Category": "HCC",
77
                          "Properties": [
78
                            {
79
                              "Property": "HCC Model Category",
80
                              "Value": "18"
81
                            },
82
                            {
83
                              "Property": "Community, Non-Dual-Aged",
84
                              "Value": "0.302"
85
                            },
86
                            {
87
                              "Property": "Community, Non-Dual-Disabled",
88
                              "Value": "0.351"
89
                            },
90
                            {
91
                              "Property": "Community, Full Benefit, Dual Aged",
92
                              "Value": "0.340"
93
                            },
94
                            {
95
                              "Property": "CCommunity, Full Benefit, Dual-Disabled",
96
                              "Value": "0.423"
97
                            },
98
                            {
99
                              "Property": "Community, Partial Benefit, Dual Aged",
100
                              "Value": "0.087"
101
                            },
102
                            {
103
                              "Property": "Community, Partial Benefit, Dual-Disabled",
104
                              "Value": "0.373"
105
                            },
106
                            {
107
                              "Property": "Institutional",
108
                              "Value": "0.440"
109
                            }
110
                          ]
111
                        }
112
                      ]
113
                    }
114
                  ]
115
                }
116
              ]
117
            },
118
            {
119
              "Codeset": "SNOMED CT",
120
              "Status": "Success",
121
              "Codes": [
122
                {
123
                  "Code": "420279001",
124
                  "MatchPriority": "Preferred",
125
                  "Variants": [
126
                    {
127
                      "Title": "Renal disorder due to type 2 diabetes mellitus",
128
                      "TitleStatus": null,
129
                      "TitleType": null,
130
                      "ExtendedProperties": []
131
                    }
132
                  ]
133
                },
134
                {
135
                  "Code": "44054006",
136
                  "MatchPriority": "Preferred",
137
                  "Variants": [
138
                    {
139
                      "Title": "Diabetes mellitus type 2 (disorder)",
140
                      "TitleStatus": null,
141
                      "TitleType": null,
142
                      "ExtendedProperties": []
143
                    }
144
                  ]
145
                }
146
              ]
147
            },
148
            {
149
              "Codeset": "ICD-9-CM",
150
              "Status": "Success",
151
              "Codes": [
152
                {
153
                  "Code": "250.00",
154
                  "MatchPriority": "Preferred",
155
                  "Variants": [
156
                    {
157
                      "Title": "Diabetes mellitus without mention of complication, type ii ",
158
                      "TitleStatus": null,
159
                      "TitleType": null,
160
                      "ExtendedProperties": []
161
                    }
162
                  ]
163
                }
164
              ]
165
            }
166
          ]
167
        }
168
      ],
169
      "Error": {
170
        "Code": null,
171
        "Message": null
172
      }
173
    }
174
  ]
175
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.