POST rest/HHSRiskScore/GetHHSRiskScores
Calculate the HSS Risk Score based on the patient demographic information and diagnosis codes available in the request.
Request Information
URI Parameters
None.
Body Parameters
HSS Risk Score Calculation request.
HHSRiskScoreRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| version |
API version number (either '1.0' or '1.1') |
string |
Required |
| clientId |
The GUID format of Client ID. This value is provided by Madicare Informatics after registration. |
string |
Required |
| benefitYear |
Benefit Year in "yyyy" format (Default: 2018). This value should be either 2018 or 2019. Benefit year is used to calculate age. The last day of enrollment in benefit year is used to calculate age. For infants born in the previous year but not discharged until the benefit year, users should substitute age 0. |
integer |
Required |
| patients |
Collection of patient demographic information and diagnosis and prescription drug codes to be used for HSS-HCC risk score calculation. |
Collection of HHSRiskScoreRequestPatient |
Required |
Request Formats
application/json, text/json
Sample:
{
"version": "sample string 1",
"clientId": "sample string 2",
"benefitYear": 3,
"patients": [
{
"requestId": "sample string 1",
"dob": "2024-12-25T15:49:23.9766055+00:00",
"gender": 0,
"metal": 0,
"enroll": 0,
"csr": 0,
"codes": [
{
"code": "sample string 1",
"dos": "2024-12-25T15:49:23.9766055+00:00"
},
{
"code": "sample string 1",
"dos": "2024-12-25T15:49:23.9766055+00:00"
}
],
"drugs": [
"sample string 1",
"sample string 2"
]
},
{
"requestId": "sample string 1",
"dob": "2024-12-25T15:49:23.9766055+00:00",
"gender": 0,
"metal": 0,
"enroll": 0,
"csr": 0,
"codes": [
{
"code": "sample string 1",
"dos": "2024-12-25T15:49:23.9766055+00:00"
},
{
"code": "sample string 1",
"dos": "2024-12-25T15:49:23.9766055+00:00"
}
],
"drugs": [
"sample string 1",
"sample string 2"
]
}
]
}
application/xml, text/xml
Sample:
<HHSRiskScoreRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediProvider.Models">
<benefitYear>3</benefitYear>
<clientId>sample string 2</clientId>
<patients>
<HHSRiskScoreRequestPatient>
<codes>
<HHSDiagnosisCode>
<code>sample string 1</code>
<dos>2024-12-25T15:49:23.9766055+00:00</dos>
</HHSDiagnosisCode>
<HHSDiagnosisCode>
<code>sample string 1</code>
<dos>2024-12-25T15:49:23.9766055+00:00</dos>
</HHSDiagnosisCode>
</codes>
<csr>CSR_INDICATOR0</csr>
<dob>2024-12-25T15:49:23.9766055+00:00</dob>
<drugs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</drugs>
<enroll>FULL_YEAR</enroll>
<gender>Male</gender>
<metal>Platinum</metal>
<requestId>sample string 1</requestId>
</HHSRiskScoreRequestPatient>
<HHSRiskScoreRequestPatient>
<codes>
<HHSDiagnosisCode>
<code>sample string 1</code>
<dos>2024-12-25T15:49:23.9766055+00:00</dos>
</HHSDiagnosisCode>
<HHSDiagnosisCode>
<code>sample string 1</code>
<dos>2024-12-25T15:49:23.9766055+00:00</dos>
</HHSDiagnosisCode>
</codes>
<csr>CSR_INDICATOR0</csr>
<dob>2024-12-25T15:49:23.9766055+00:00</dob>
<drugs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</drugs>
<enroll>FULL_YEAR</enroll>
<gender>Male</gender>
<metal>Platinum</metal>
<requestId>sample string 1</requestId>
</HHSRiskScoreRequestPatient>
</patients>
<version>sample string 1</version>
</HHSRiskScoreRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HHSRiskScoreResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| version |
API response version number (either '1.0' or '1.1'). Usually, the response version number is same the request version number. |
string |
Required |
| clientId |
The GUID format of Client ID. This value is provided by Madicare Informatics after registration. The reponse Client ID must be same as the request Client ID. |
string |
Required |
| errMsg |
Error message describes why it failed. |
string |
Required |
| patients |
The collection of patients' response. |
Collection of HHSRiskScorePatientDetail |
Required |
Response Formats
application/json, text/json
Sample:
{
"version": "sample string 1",
"clientId": "sample string 2",
"errMsg": "sample string 3",
"patients": [
{
"requestId": "sample string 1",
"demographics": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
},
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
}
],
"hccGroup": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"illnessInteractions": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"enrollment": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"rxcs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
},
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
}
],
"rxcInteractions": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"maturityInteraction": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"riskScore": 2.1,
"adjustedRiskScore": 3.1
},
{
"requestId": "sample string 1",
"demographics": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
},
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
}
],
"hccGroup": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"illnessInteractions": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"enrollment": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"rxcs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
},
{
"code": "sample string 1",
"desc": "sample string 2",
"hccs": [
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"drop": true,
"reason": "sample string 4",
"score": 5.1
}
]
}
],
"rxcInteractions": [
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
{
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
}
],
"maturityInteraction": {
"code": "sample string 1",
"desc": "sample string 2",
"score": 3.1
},
"riskScore": 2.1,
"adjustedRiskScore": 3.1
}
]
}
application/xml, text/xml
Sample:
<HHSRiskScoreResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediProvider.Models">
<clientId>sample string 2</clientId>
<errMsg>sample string 3</errMsg>
<patients>
<HHSRiskScorePatientDetail>
<adjustedRiskScore>3.1</adjustedRiskScore>
<demographics>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</demographics>
<enrollment>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</enrollment>
<hccGroup>
<HHSResponseVariable>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSResponseVariable>
<HHSResponseVariable>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSResponseVariable>
</hccGroup>
<hccs>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
</hccs>
<illnessInteractions>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
</illnessInteractions>
<maturityInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</maturityInteraction>
<requestId>sample string 1</requestId>
<riskScore>2.1</riskScore>
<rxcInteractions>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
</rxcInteractions>
<rxcs>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
</rxcs>
</HHSRiskScorePatientDetail>
<HHSRiskScorePatientDetail>
<adjustedRiskScore>3.1</adjustedRiskScore>
<demographics>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</demographics>
<enrollment>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</enrollment>
<hccGroup>
<HHSResponseVariable>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSResponseVariable>
<HHSResponseVariable>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSResponseVariable>
</hccGroup>
<hccs>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
</hccs>
<illnessInteractions>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
</illnessInteractions>
<maturityInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</maturityInteraction>
<requestId>sample string 1</requestId>
<riskScore>2.1</riskScore>
<rxcInteractions>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
<HHSRiskScoreInteraction>
<code>sample string 1</code>
<desc>sample string 2</desc>
<score>3.1</score>
</HHSRiskScoreInteraction>
</rxcInteractions>
<rxcs>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
<HHSRiskScoreDiagnosisDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<hccs>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
<HHSRiskScoreHccDetail>
<code>sample string 1</code>
<desc>sample string 2</desc>
<drop>true</drop>
<reason>sample string 4</reason>
<score>5.1</score>
</HHSRiskScoreHccDetail>
</hccs>
</HHSRiskScoreDiagnosisDetail>
</rxcs>
</HHSRiskScorePatientDetail>
</patients>
<version>sample string 1</version>
</HHSRiskScoreResponse>