Quick Reference

All API access is over HTTP, and accessed via the https://ipl.e-imo.com domain. The relative path prefix /api/v3/ indicates that we are currently using version 3 of the API.

Functions

URL HTTP Verb Functionality
/api/v3/actions/categorize POST Categorize Problem List
/api/v3/actions/specialize POST Specialize Problem List
/api/v3/actions/clean POST Reconcile Problem List
Authentication

Authentication is done using HTTP Basic Authentication (Wikipedia).

Once you have your APIKey and APISecret from IMO follow this simple formula to construct the Authorization header.

Authorization: "Basic: " + Base64Encode(APIKey + ":" + APISecret)

Request Format

The request format must be specified in the Content-Type header as one of the following:

  • JSON: application/json

JSON is the recommended format.

Response Format

The response format must be specified in the Accept header as one of the following:

  • JSON: application/json

The response body will contain a Request field detailing the request sent to the server.

Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx or 5xx status code indicates failure. For more on errors see below.

Object: Category

A Category object details the properties of a category and lists the Problem objects in that category.

Example:
{
    "Code": "1143548347",
    "Name": "Cardiac and Vasculature",
    "SortOrder": {
        "imo": 300,
        "alpha": 0
    },
    "Problems": [
        ...
    ]
}
Object: Specialty

A Specialty object details the properties of a specialty and lists the Problem objects in that specialty.

Example:
{
    "Code": "1337",
    "Name": "IMO Specialty",
    "SortOrder": {
        "imo": 1,
        "alpha": 1
    },
    "Problems": [
        ...
    ]
}
Object: Problem

A Problem object details the properties of a problem.

Example:
{
    "Code": "1",
    "FreeText": "Heart Attack",
    "ImoLexicalId" : "50263",
    "PreferredLexicalText": "Heart attack",
    "EntryDate": "2018-07-10T00:00:00-05:00",
    "OnsetDate": "2018-07-10T00:00:00-05:00",
    "SortOrder": {
        "imo": 3,
        "alpha": 0
    },
    "Details": {
        "IMO": "50263",
        "IMOTitle": "Heart attack",
        "ICD10": "I21.3",
        "ICD10Title": "ST elevation (STEMI) myocardial infarction of unspecified site",
        "SNOMED": "22298006",
        "SNOMEDTitle": "Myocardial infarction",
        "ICD9": "410.90",
        "ICD9Title": "AMI NOS, unspecified",
        "PosStdDev": "0.000",
        "Similarity": "1.000",
        "SpecialtyCode": "1337",
        "SpecialtyTitle": "IMO Specialty",
        "SpecialtyOrder": "1",
        "CategoryCode": "1143548347",
        "CategoryTitle": "Cardiac and Vasculature",
        "CategoryOrder": "300",
        "ClusterCode": "1035677191",
        "ClusterTitle": "Coronary artery",
        "ClusterOrder": "3",
        "MCCFlag": "False",
        "CCFlag": "False",
        "HCCCategoryCode": "87"
    }
}
Object: Lapsed

A Lapsed object lists out problems that are expired.

Example:
{
    "DateUsedInCalculations": "2016-06-02T00:00:00",
    "ImoLexicalId": "50263",
    "Code": "1",
    "FreeText": "Heart Attack"
}
Object: Duplicates

A Duplicate object lists out problems with the exact or synonymous matches.

Example:
[
    {
        "Id": "2dcea3ab-1ad0-457d-91db-a9138a2efbba",
        "Problems": [
            {
                "ImoLexicalId": "50263",
                "Code": "1",
                "FreeText": "Heart Attack"
            },
            {
                "ImoLexicalId": "50276",
                "Code": "2",
                "FreeText": "myocardial infarction"
            }
        ]
    }
]
Function: Categorize

The /api/v3/actions/categorize endpoint will categorize a given list of medical problems or categorize and recommend a clean list of medical problems.

The categorize request body must be formatted as follows:

{
    "Properties": {
        "PatientId": "205028345"
    },
    "Problems": [
        {
            "Code": "1",
            "FreeText": "Heart Attack",
            "Properties": {
                "MyICD10Code": "I21.3"
            }
        },
        {
            "Code": "2",
            "FreeText": "sty"
        }
    ]
}

Or, at minimum:

{
    "Problems": [
        {
            "FreeText": "Heart Attack",
        },
        {
            "FreeText": "sty"
        }
    ]
}

Response:

{
    "Request": {
        "Properties": {
            "PatientId": "205028345"
        },
        "Problems": [
            {
                "Code": "1",
                "FreeText": "Heart Attack",
                "Properties": {
                    "MyICD10Code": "I21.3"
                }
            },
            {
                "Code": "2",
                "FreeText": "sty"
            }
        ]
    },
    "Categories": [
        {
            "Code": "1143548347",
            "Name": "Cardiac and Vasculature",
            "SortOrder": {
                "imo": 300,
                "alpha": 0
            },
            "Problems": [
                {
                    "Code": "1",
                    "FreeText": "Heart Attack",
                    "PreferredLexicalText": "Heart attack",
                    "SortOrder": {
                        "imo": 3,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "50263",
                        "IMOTitle": "Heart attack",
                        "ICD10": "I21.3",
                        "ICD10Title": "ST elevation (STEMI) myocardial infarction of unspecified site",
                        "SNOMED": "22298006",
                        "SNOMEDTitle": "Myocardial infarction",
                        "ICD9": "410.90",
                        "ICD9Title": "AMI NOS, unspecified",
                        "PosStdDev": "0.000",
                        "Similarity": "1.000",
                        "CategoryCode": "1143548347",
                        "CategoryTitle": "Cardiac and Vasculature",
                        "CategoryOrder": "300",
                        "ClusterCode": "1035677191",
                        "ClusterTitle": "Coronary artery",
                        "ClusterOrder": "3",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "87"
                    }
                }
            ]
        },
        {
            "Code": "1040456519",
            "Name": "Eye",
            "SortOrder": {
                "imo": 470,
                "alpha": 1
            },
            "Problems": [
                {
                    "Code": "2",
                    "FreeText": "sty",
                    "PreferredLexicalText": "Sty",
                    "SortOrder": {
                        "imo": 100,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "46523",
                        "IMOTitle": "Sty",
                        "ICD10": "H00.019",
                        "ICD10Title": "Hordeolum externum unspecified eye, unspecified eyelid",
                        "SNOMED": "1489008",
                        "SNOMEDTitle": "External hordeolum",
                        "ICD9": "373.11",
                        "ICD9Title": "Hordeolum externum",
                        "PosStdDev": "0.000",
                        "Similarity": "1.000",
                        "CategoryCode": "1040456519",
                        "CategoryTitle": "Eye",
                        "CategoryOrder": "470",
                        "ClusterCode": "1035677196",
                        "ClusterTitle": "Eye",
                        "ClusterOrder": "100",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                }
            ]
        }
    ]
}

The categorize and clean request body must include the property "Clean" set to "true":

{

{
 
    "Clean": true,
    "problems": [{
            "Code": "1",
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "Code": "1",
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "Code": "1",
            "imoLexicalId": "1082668",
            "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
        },
        {
            "Code": "46E6C98C2C0EE73B",
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
            "OnsetDate": "2/2/2017",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "9A03326762F238E9",
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother",
            "OnsetDate": "6/2/2018",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "2",
            "imoLexicalId": "314965",
            "FreeText": "Major depression, recurrent (HCC)"
        },
        {
            "Code": "1",
            "ImoLexicalId": "59691711",
            "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
        },
        {
            "Code": "2",
            "ImoLexicalId": "514373",
            "FreeText": "CAD (coronary artery disease), native coronary artery"
        },
        {
            "Code": "3",
            "ImoLexicalId": "30422",
            "FreeText": "Essential hypertension"
        }
    ]
}

Or, at minimum:

{
 
    "Clean": true,
    "problems": [{
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "imoLexicalId": "1082668",
            "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
        },
        {
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
            "EntryDate": "8/25/2017"
        },
        {
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "2",
            "imoLexicalId": "314965",
            "FreeText": "Major depression, recurrent (HCC)"
        },
        {
            "ImoLexicalId": "59691711",
            "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
        },
        {
            "ImoLexicalId": "514373",
            "FreeText": "CAD (coronary artery disease), native coronary artery"
        },
        {
            "ImoLexicalId": "30422",
            "FreeText": "Essential hypertension"
        }
    ]
}

Response:

{
    "Categories": [
        {
            "Code": "1068676071",
            "Name": "Cardiac and Vasculature",
            "SortOrder": {
                "imo": 300,
                "alpha": 0
            },
            "Problems": [
                {
                    "FreeText": "Essential hypertension",
                    "ImoLexicalId": "30422",
                    "PreferredLexicalText": "Essential hypertension",
                    "SortOrder": {
                        "imo": 10,
                        "alpha": 2
                    },
                    "Details": {
                        "IMO": "30422",
                        "IMOTitle": "Essential hypertension",
                        "ICD10": "I10",
                        "ICD10Title": "Essential (primary) hypertension",
                        "SNOMED": "59621000",
                        "SNOMEDTitle": "Essential hypertension",
                        "ICD9": "401.9",
                        "ICD9Title": "Unspecified essential hypertension",
                        "CategoryCode": "1068676071",
                        "CategoryTitle": "Cardiac and Vasculature",
                        "CategoryOrder": "300",
                        "ClusterCode": "1424614087",
                        "ClusterTitle": "CV: Hypertension Cluster",
                        "ClusterOrder": "10",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                },
                {
                    "FreeText": "CAD (coronary artery disease), native coronary artery",
                    "ImoLexicalId": "514373",
                    "PreferredLexicalText": "CAD (coronary artery disease), native coronary artery",
                    "SortOrder": {
                        "imo": 40,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "514373",
                        "IMOTitle": "CAD (coronary artery disease), native coronary artery",
                        "ICD10": "I25.10",
                        "ICD10Title": "Atherosclerotic heart disease of native coronary artery without angina pectoris",
                        "SNOMED": "1641000119107",
                        "SNOMEDTitle": "Coronary arteriosclerosis in native artery",
                        "ICD9": "414.01",
                        "ICD9Title": "Coronary atherosclerosis of native coronary artery",
                        "CategoryCode": "1068676071",
                        "CategoryTitle": "Cardiac and Vasculature",
                        "CategoryOrder": "300",
                        "ClusterCode": "1035677191",
                        "ClusterTitle": "CV: Coronary artery Cluster",
                        "ClusterOrder": "40",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                },
                {
                    "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris",
                    "ImoLexicalId": "59691711",
                    "PreferredLexicalText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris",
                    "SortOrder": {
                        "imo": 40,
                        "alpha": 1
                    },
                    "Details": {
                        "IMO": "59691711",
                        "IMOTitle": "Coronary artery disease involving native coronary artery of native heart without angina pectoris",
                        "ICD10": "I25.10",
                        "ICD10Title": "Atherosclerotic heart disease of native coronary artery without angina pectoris",
                        "SNOMED": "1641000119107",
                        "SNOMEDTitle": "Coronary arteriosclerosis in native artery",
                        "ICD9": "414.01",
                        "ICD9Title": "Coronary atherosclerosis of native coronary artery",
                        "CategoryCode": "1068676071",
                        "CategoryTitle": "Cardiac and Vasculature",
                        "CategoryOrder": "300",
                        "ClusterCode": "1035677191",
                        "ClusterTitle": "CV: Coronary artery Cluster",
                        "ClusterOrder": "40",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                }
            ]
        },
        {
            "Code": "1040459349",
            "Name": "Genitourinary and Reproductive",
            "SortOrder": {
                "imo": 600,
                "alpha": 1
            },
            "Problems": [
                {
                    "FreeText": "Uremia",
                    "ImoLexicalId": "76792",
                    "PreferredLexicalText": "Uremia",
                    "SortOrder": {
                        "imo": 100,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "76792",
                        "IMOTitle": "Uremia",
                        "ICD10": "N19",
                        "ICD10Title": "Unspecified kidney failure",
                        "SNOMED": "44730006",
                        "SNOMEDTitle": "Uremia",
                        "ICD9": "586",
                        "ICD9Title": "Renal failure, unspecified",
                        "CategoryCode": "1040459349",
                        "CategoryTitle": "Genitourinary and Reproductive",
                        "CategoryOrder": "600",
                        "ClusterCode": "1035677190",
                        "ClusterTitle": "GR: Kidney, Ureter Cluster",
                        "ClusterOrder": "100",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                },
                {
                    "FreeText": "Uremia",
                    "ImoLexicalId": "76792",
                    "PreferredLexicalText": "Uremia",
                    "SortOrder": {
                        "imo": 100,
                        "alpha": 1
                    },
                    "Details": {
                        "IMO": "76792",
                        "IMOTitle": "Uremia",
                        "ICD10": "N19",
                        "ICD10Title": "Unspecified kidney failure",
                        "SNOMED": "44730006",
                        "SNOMEDTitle": "Uremia",
                        "ICD9": "586",
                        "ICD9Title": "Renal failure, unspecified",
                        "CategoryCode": "1040459349",
                        "CategoryTitle": "Genitourinary and Reproductive",
                        "CategoryOrder": "600",
                        "ClusterCode": "1035677190",
                        "ClusterTitle": "GR: Kidney, Ureter Cluster",
                        "ClusterOrder": "100",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                }
            ]
        },
        {
            "Code": "1040459350",
            "Name": "Gravid and Perinatal",
            "SortOrder": {
                "imo": 700,
                "alpha": 2
            },
            "Problems": [
                {
                    "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
                    "ImoLexicalId": "1606163",
                    "EntryDate": "2017-08-25T00:00:00",
                    "PreferredLexicalText": "Encounter for supervision of normal first pregnancy in first trimester",
                    "IsExpired": true,
                    "SortOrder": {
                        "imo": 10,
                        "alpha": 1
                    },
                    "Details": {
                        "IMO": "1606163",
                        "IMOTitle": "Encounter for supervision of normal first pregnancy in first trimester",
                        "ICD10": "Z34.01",
                        "ICD10Title": "Encounter for supervision of normal first pregnancy, first trimester",
                        "SNOMED": "72892002",
                        "SNOMEDTitle": "Normal pregnancy",
                        "ICD9": "V22.0",
                        "ICD9Title": "Supervision of normal first pregnancy",
                        "CategoryCode": "1040459350",
                        "CategoryTitle": "Gravid and Perinatal",
                        "CategoryOrder": "700",
                        "ClusterCode": "1035677168",
                        "ClusterTitle": "GP: Pregnancy Cluster",
                        "ClusterOrder": "10",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                },
                {
                    "FreeText": "Encounter for antenatal screening of mother",
                    "ImoLexicalId": "525422",
                    "EntryDate": "2017-08-25T00:00:00",
                    "PreferredLexicalText": "Encounter for antenatal screening of mother",
                    "IsExpired": true,
                    "SortOrder": {
                        "imo": 999,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "525422",
                        "IMOTitle": "Encounter for antenatal screening of mother",
                        "ICD10": "Z36.9",
                        "ICD10Title": "Encounter for antenatal screening, unspecified",
                        "SNOMED": "305058001",
                        "SNOMEDTitle": "Patient encounter status",
                        "ICD9": "V28.9",
                        "ICD9Title": "Unspecified antenatal screening",
                        "CategoryCode": "1040459350",
                        "CategoryTitle": "Gravid and Perinatal",
                        "CategoryOrder": "700",
                        "ClusterCode": "1035695100",
                        "ClusterTitle": "GP: Gravid, Perinatal Misc Cluster",
                        "ClusterOrder": "999",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                }
            ]
        },
        {
            "Code": "1329153647",
            "Name": "Mental Health",
            "SortOrder": {
                "imo": 1075,
                "alpha": 3
            },
            "Problems": [
                {
                    "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)",
                    "ImoLexicalId": "1082668",
                    "PreferredLexicalText": "Major depressive disorder, recurrent episode, severe, with psychosis",
                    "SortOrder": {
                        "imo": 20,
                        "alpha": 1
                    },
                    "Details": {
                        "IMO": "1082668",
                        "IMOTitle": "Major depressive disorder, recurrent episode, severe, with psychosis",
                        "ICD10": "F33.3",
                        "ICD10Title": "Major depressive disorder, recurrent, severe with psychotic symptoms",
                        "SNOMED": "191613003",
                        "SNOMEDTitle": "Recurrent major depressive episodes, severe, with psychosis",
                        "ICD9": "296.34",
                        "ICD9Title": "Major depressive disorder, recurrent episode, severe, specified as with psychotic behavior",
                        "CategoryCode": "1329153647",
                        "CategoryTitle": "Mental Health",
                        "CategoryOrder": "1075",
                        "ClusterCode": "1035677189",
                        "ClusterTitle": "MH: Mental Health Cluster",
                        "ClusterOrder": "20",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "59"
                    }
                },
                {
                    "Code": "2",
                    "FreeText": "Major depression, recurrent (HCC)",
                    "ImoLexicalId": "314965",
                    "PreferredLexicalText": "Major depression, recurrent",
                    "SortOrder": {
                        "imo": 20,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "314965",
                        "IMOTitle": "Major depression, recurrent",
                        "ICD10": "F33.9",
                        "ICD10Title": "Major depressive disorder, recurrent, unspecified",
                        "SNOMED": "66344007",
                        "SNOMEDTitle": "Recurrent major depression",
                        "ICD9": "296.30",
                        "ICD9Title": "Major depressive disorder, recurrent episode, unspecified",
                        "CategoryCode": "1329153647",
                        "CategoryTitle": "Mental Health",
                        "CategoryOrder": "1075",
                        "ClusterCode": "1035677189",
                        "ClusterTitle": "MH: Mental Health Cluster",
                        "ClusterOrder": "20",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "59"
                    }
                }
            ]
        }
    ],
    "Lapsed": [
        {
            "DateUsedInCalculations": "2017-08-25T00:00:00",
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester"
        },
        {
            "DateUsedInCalculations": "2017-08-25T00:00:00",
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother"
        }
    ],
    "Duplicates": [
        {
            "Id": "0e792687-2ba0-40b1-80a2-29640a99656b",
            "Problems": [
                {
                    "ImoLexicalId": "76792",
                    "FreeText": "Uremia"
                },
                {
                    "ImoLexicalId": "76792",
                    "FreeText": "Uremia"
                }
            ]
        }
    ],
    "Related": [
        {
            "Id": "971b4467-a8c8-4311-b448-6e2ab0f306de",
            "Problems": [
                {
                    "ImoLexicalId": "314965",
                    "Code": "2",
                    "FreeText": "Major depression, recurrent (HCC)"
                },
                {
                    "ImoLexicalId": "1082668",
                    "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
                }
            ]
        },
        {
            "Id": "1678c46d-45d6-4fac-9810-04b86b5a09ae",
            "Problems": [
                {
                    "ImoLexicalId": "59691711",
                    "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
                },
                {
                    "ImoLexicalId": "514373",
                    "FreeText": "CAD (coronary artery disease), native coronary artery"
                }
            ]
        }
    ],
    "Request": {
        "Clean": true,
        "Problems": [
            {
                "FreeText": "Uremia",
                "ImoLexicalId": "76792"
            },
            {
                "FreeText": "Uremia",
                "ImoLexicalId": "76792"
            },
            {
                "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)",
                "ImoLexicalId": "1082668"
            },
            {
                "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
                "ImoLexicalId": "1606163",
                "EntryDate": "2017-08-25T00:00:00"
            },
            {
                "FreeText": "Encounter for antenatal screening of mother",
                "ImoLexicalId": "525422",
                "EntryDate": "2017-08-25T00:00:00"
            },
            {
                "Code": "2",
                "FreeText": "Major depression, recurrent (HCC)",
                "ImoLexicalId": "314965"
            },
            {
                "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris",
                "ImoLexicalId": "59691711"
            },
            {
                "FreeText": "CAD (coronary artery disease), native coronary artery",
                "ImoLexicalId": "514373"
            },
            {
                "FreeText": "Essential hypertension",
                "ImoLexicalId": "30422"
            }
        ]
    }
}
NEW: IMO Lexical Support

IMO Lexical Ids can also be provided.

{
    "Problems": [
        {
            "FreeText": "Heart Attack",
        },
        {
            "ImoLexicalId" : "46523",
        },
        {
            "FreeText": "Hypothyroidism, Acquired",
            "ImoLexicalId" : "75076"
        }
    ]
}

Response:

{
    "Request": {
        "Properties": {
            "PatientId": "205028345"
        },
        "Problems": [
            {
                "FreeText": "Heart Attack"

            },
            {
                "ImoLexicalId" : "46523"
            },
            {
                "FreeText": "Hypothyroidism, Acquired",
                "ImoLexicalId": "75076"
            }
        ]
    },
    "Categories": [
        {
            "Code": "1143548347",
            "Name": "Cardiac and Vasculature",
            "SortOrder": {
                "imo": 300,
                "alpha": 0
            },
            "Problems": [
                {
                    "FreeText": "Heart Attack",
                    "PreferredLexicalText": "Heart attack",
                    "SortOrder": {
                        "imo": 3,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "50263",
                        "IMOTitle": "Heart attack",
                        "ICD10": "I21.3",
                        "ICD10Title": "ST elevation (STEMI) myocardial infarction of unspecified site",
                        "SNOMED": "22298006",
                        "SNOMEDTitle": "Myocardial infarction",
                        "ICD9": "410.90",
                        "ICD9Title": "AMI NOS, unspecified",
                        "PosStdDev": "0.000",
                        "Similarity": "1.000",
                        "CategoryCode": "1143548347",
                        "CategoryTitle": "Cardiac and Vasculature",
                        "CategoryOrder": "300",
                        "ClusterCode": "1035677191",
                        "ClusterTitle": "Coronary artery",
                        "ClusterOrder": "3",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "87"
                    }
                }
            ]
        },
        {
            "Code": "1040456519",
            "Name": "Eye",
            "SortOrder": {
                "imo": 470,
                "alpha": 1
            },
            "Problems": [
                {
                    "ImoLexicalId" : "46523",
                    "SortOrder": {
                        "imo": 100,
                        "alpha": 0
                    },
                    "Details": {
                        "IMO": "46523",
                        "IMOTitle": "Sty",
                        "ICD10": "H00.019",
                        "ICD10Title": "Hordeolum externum unspecified eye, unspecified eyelid",
                        "SNOMED": "1489008",
                        "SNOMEDTitle": "External hordeolum",
                        "ICD9": "373.11",
                        "ICD9Title": "Hordeolum externum",
                        "PosStdDev": "0.000",
                        "Similarity": "1.000",
                        "CategoryCode": "1040456519",
                        "CategoryTitle": "Eye",
                        "CategoryOrder": "470",
                        "ClusterCode": "1035677196",
                        "ClusterTitle": "Eye",
                        "ClusterOrder": "100",
                        "MCCFlag": "False",
                        "CCFlag": "False",
                        "HCCCategoryCode": "0"
                    }
                },
            {
            "Code": "1040459356",
            "Name": "Endocrine and Metabolic",
            "SortOrder": {
                "imo": 400,
                "alpha": 1
            },
            "Problems": [
                {
                    "FreeText": "Hypothyroidism, Acquired",
                    "ImoLexicalId": "75076",
                    "SortOrder": {
                    "imo": 30,
                    "alpha": 1
                    },
                    "Details": {
                    "LexicalCode": "75076",
                    "LexicalTitle": "Hypothyroidism (acquired)",
                    "ICD10Code": "E03.9",
                    "ICD10Title": "Hypothyroidism, unspecified",
                    "SNOMEDCode": "111566002",
                    "SNOMEDTitle": "Acquired hypothyroidism",
                    "ICD9Code": "244.9",
                    "ICD9Title": "Unspecified hypothyroidism",
                    "DefaultLexicalTextImoCode": "18848",
                    "CategoryCode": "1040459356",
                    "CategoryTitle": "Endocrine and Metabolic",
                    "CategoryOrder": "400",
                    "ClusterCode": "1035677182",
                    "ClusterTitle": "EM:  Thyroid Cluster",
                    "ClusterOrder": "30",
                    "MCCFlag": "False",
                    "CCFlag": "False",
                    "HCCCategoryCode": "0"
                    }
                }
            ]
        }
    ]
}
Function: Specialize

The /api/v3/actions/specialize endpoint will categorize a given list of medical problems.

The request body must be formatted as follows:

{
    "Problems": [
        {
            "Code": "1",
            "FreeText": "HTN - Hypertension"
        },
        {
            "Code": "2",
            "FreeText": "Elevated glycosylated hemoglobin"
        }
    ],
    "Specialties": [
        {
            "Code": "63173",
            "Name": "cardiology"
        }
    ]
}

Or, at minimum:

{
    "Problems": [
        {
            "FreeText": "HTN - Hypertension"
        },
        {
            "FreeText": "Elevated glycosylated hemoglobin"
        }
    ],
    "Specialties": [
        {
            "Code": "63173"
        }
    ]
}

Response:

{
  "Request": {
    "Problems": [
      {
        "Code": "1",
        "FreeText": "HTN - Hypertension"
      },
      {
        "Code": "2",
        "FreeText": "Elevated glycosylated hemoglobin"
      }
    ],
    "Specialties": [
      {
        "Code": "63173",
        "Name": "cardiology"
      }
    ]
  },
  "Specialties": [
    {
      "Code": "63173",
      "Name": "cardiology",
      "SortOrder": {},
      "Problems": [
        {
          "Code": "1",
          "FreeText": "HTN - Hypertension",
          "SortOrder": {},
          "Details": {
            "IMO": "703765",
            "IMOTitle": "HTN - hypertension",
            "ICD10": "I10",
            "ICD10Title": "Essential (primary) hypertension",
            "SNOMED": "38341003",
            "SNOMEDTitle": "Hypertensive disorder",
            "ICD9": "401.9",
            "ICD9Title": "Unspecified essential hypertension",
            "PosStdDev": "0.000",
            "Similarity": "1.000",
            "SpecialtyCode": "63173",
            "SpecialtyTitle": "cardiology",
            "MCCFlag": "False",
            "CCFlag": "False",
            "HCCCategoryCode": "0"
          }
        }
      ]
    }
  ]
}
Function: Reconcile

The /api/v3/actions/clean endpoint will recommend duplicate and related problems for a given list of medical problems.

The Reconcile request body must be formatted as follows, IMOLexicalId is needed to run reconcile function:

{
    "Properties": {
        "PatientId": "205028345"
    },
    "problems": [{
            "Code": "1",
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "Code": "1",
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "Code": "1",
            "imoLexicalId": "1082668",
            "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
        },
        {
            "Code": "46E6C98C2C0EE73B",
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
            "OnsetDate": "2/2/2017",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "9A03326762F238E9",
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother",
            "OnsetDate": "6/2/2018",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "2",
            "imoLexicalId": "314965",
            "FreeText": "Major depression, recurrent (HCC)"
        },
        {
            "Code": "1",
            "ImoLexicalId": "59691711",
            "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
        },
        {
            "Code": "2",
            "ImoLexicalId": "514373",
            "FreeText": "CAD (coronary artery disease), native coronary artery"
        },
        {
            "Code": "3",
            "ImoLexicalId": "30422",
            "FreeText": "Essential hypertension"
        }
    ]
}

Or, at minimum:

{
    "problems": [{
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "ImoLexicalId": "76792",
            "FreeText": "Uremia"
        },
        {
            "imoLexicalId": "1082668",
            "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
        },
        {
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
            "EntryDate": "8/25/2017"
        },
        {
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother",
            "EntryDate": "8/25/2017"
        },
        {
            "Code": "2",
            "imoLexicalId": "314965",
            "FreeText": "Major depression, recurrent (HCC)"
        },
        {
            "ImoLexicalId": "59691711",
            "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
        },
        {
            "ImoLexicalId": "514373",
            "FreeText": "CAD (coronary artery disease), native coronary artery"
        },
        {
            "ImoLexicalId": "30422",
            "FreeText": "Essential hypertension"
        }
    ]
}

Response:

{
    "Lapsed": [
        {
            "DateUsedInCalculations": "2017-08-25T00:00:00",
            "ImoLexicalId": "1606163",
            "FreeText": "Encounter for supervision of normal first pregnancy in first trimester"
        },
        {
            "DateUsedInCalculations": "2017-08-25T00:00:00",
            "ImoLexicalId": "525422",
            "FreeText": "Encounter for antenatal screening of mother"
        }
    ],
    "Duplicates": [
        {
            "Id": "6240805b-830d-44c1-9ea4-404a2dfc3733",
            "Problems": [
                {
                    "ImoLexicalId": "76792",
                    "FreeText": "Uremia"
                },
                {
                    "ImoLexicalId": "76792",
                    "FreeText": "Uremia"
                }
            ]
        }
    ],
    "Related": [
        {
            "Id": "acab7ce3-831e-4444-93ad-529dde189ddb",
            "Problems": [
                {
                    "ImoLexicalId": "314965",
                    "Code": "2",
                    "FreeText": "Major depression, recurrent (HCC)"
                },
                {
                    "ImoLexicalId": "1082668",
                    "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)"
                }
            ]
        },
        {
            "Id": "18084686-1338-436b-b34c-2fbb4f592d1a",
            "Problems": [
                {
                    "ImoLexicalId": "59691711",
                    "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris"
                },
                {
                    "ImoLexicalId": "514373",
                    "FreeText": "CAD (coronary artery disease), native coronary artery"
                }
            ]
        }
    ],
    "Request": {
        "Problems": [
            {
                "FreeText": "Uremia",
                "ImoLexicalId": "76792"
            },
            {
                "FreeText": "Uremia",
                "ImoLexicalId": "76792"
            },
            {
                "FreeText": "Major depressive disorder, recurrent episode, severe, with psychosis (HCC)",
                "ImoLexicalId": "1082668"
            },
            {
                "FreeText": "Encounter for supervision of normal first pregnancy in first trimester",
                "ImoLexicalId": "1606163",
                "EntryDate": "2017-08-25T00:00:00"
            },
            {
                "FreeText": "Encounter for antenatal screening of mother",
                "ImoLexicalId": "525422",
                "EntryDate": "2017-08-25T00:00:00"
            },
            {
                "Code": "2",
                "FreeText": "Major depression, recurrent (HCC)",
                "ImoLexicalId": "314965"
            },
            {
                "FreeText": "Coronary artery disease involving native coronary artery of native heart without angina pectoris",
                "ImoLexicalId": "59691711"
            },
            {
                "FreeText": "CAD (coronary artery disease), native coronary artery",
                "ImoLexicalId": "514373"
            },
            {
                "FreeText": "Essential hypertension",
                "ImoLexicalId": "30422"
            }
        ]
    }
}
Errors

When a request fails, the response body will be in the format specified in the Accept header, and will contain the fields ErrorMessage and DevErrorMessage.

Error Codes:

Status Code Name Why?
200 OK All systems go.
400 Bad Request The request values were incorrect or badly formatted.
401 Unauthorized Invalid APIKey or APIKey not given.
404 Not found Could not communicate with IPL.
415 Unsupported Media Type Content-Type header must be set to application/json
500 Internal Server Error Server side error. Contact CustomerSupport@e-imo.com.
503 Service Unavailable Server side error. Contact CustomerSupport@e-imo.com.