GET api44796e616d6963/PatientMetrics
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ReportMetrics| Name | Description | Type | Additional information |
|---|---|---|---|
| Program | string |
None. |
|
| PracticeID | string |
None. |
|
| ProviderID | string |
None. |
|
| DateFrom | date |
None. |
|
| DateTo | date |
None. |
|
| Measure | string |
None. |
|
| GlobalIndicator | boolean |
None. |
|
| PatientInfoList | Collection of PatientInfo |
None. |
|
| IsServiceError | boolean |
None. |
|
| ServiceErrorMessage | string |
None. |
|
| NumeratorCount | integer |
None. |
|
| DenominatorCount | integer |
None. |
|
| Percentage | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Program": "sample string 1",
"PracticeID": "sample string 2",
"ProviderID": "sample string 3",
"DateFrom": "2025-10-27T21:15:27.1741857+00:00",
"DateTo": "2025-10-27T21:15:27.1741857+00:00",
"Measure": "sample string 6",
"GlobalIndicator": true,
"PatientInfoList": [
{
"PatientFirstName": "sample string 1",
"PatientLastName": "sample string 2",
"PatientDOB": "2025-10-27T21:15:27.1741857+00:00",
"PatientGender": "sample string 4",
"PatientID": "sample string 5",
"VisitID": "sample string 6",
"VisitDateTime": "2025-10-27T21:15:27.1741857+00:00",
"NumeratorConditionStatus": true,
"NumeratorDateTime": "2025-10-27T21:15:27.1741857+00:00",
"NumberOfSecureMessages": 10,
"DenominatorCount": 11
},
{
"PatientFirstName": "sample string 1",
"PatientLastName": "sample string 2",
"PatientDOB": "2025-10-27T21:15:27.1741857+00:00",
"PatientGender": "sample string 4",
"PatientID": "sample string 5",
"VisitID": "sample string 6",
"VisitDateTime": "2025-10-27T21:15:27.1741857+00:00",
"NumeratorConditionStatus": true,
"NumeratorDateTime": "2025-10-27T21:15:27.1741857+00:00",
"NumberOfSecureMessages": 10,
"DenominatorCount": 11
}
],
"IsServiceError": true,
"ServiceErrorMessage": "sample string 9",
"NumeratorCount": 10,
"DenominatorCount": 11,
"Percentage": 12
}
application/xml, text/xml
Sample:
<ReportMetrics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiCommonFramework">
<DateFrom>2025-10-27T21:15:27.1741857+00:00</DateFrom>
<DateTo>2025-10-27T21:15:27.1741857+00:00</DateTo>
<DenominatorCount>11</DenominatorCount>
<GlobalIndicator>true</GlobalIndicator>
<IsServiceError>true</IsServiceError>
<Measure>sample string 6</Measure>
<NumeratorCount>10</NumeratorCount>
<PatientInfoList>
<PatientInfo>
<DenominatorCount>11</DenominatorCount>
<NumberOfSecureMessages>10</NumberOfSecureMessages>
<NumeratorConditionStatus>true</NumeratorConditionStatus>
<NumeratorDateTime>2025-10-27T21:15:27.1741857+00:00</NumeratorDateTime>
<PatientDOB>2025-10-27T21:15:27.1741857+00:00</PatientDOB>
<PatientFirstName>sample string 1</PatientFirstName>
<PatientGender>sample string 4</PatientGender>
<PatientID>sample string 5</PatientID>
<PatientLastName>sample string 2</PatientLastName>
<VisitDateTime>2025-10-27T21:15:27.1741857+00:00</VisitDateTime>
<VisitID>sample string 6</VisitID>
</PatientInfo>
<PatientInfo>
<DenominatorCount>11</DenominatorCount>
<NumberOfSecureMessages>10</NumberOfSecureMessages>
<NumeratorConditionStatus>true</NumeratorConditionStatus>
<NumeratorDateTime>2025-10-27T21:15:27.1741857+00:00</NumeratorDateTime>
<PatientDOB>2025-10-27T21:15:27.1741857+00:00</PatientDOB>
<PatientFirstName>sample string 1</PatientFirstName>
<PatientGender>sample string 4</PatientGender>
<PatientID>sample string 5</PatientID>
<PatientLastName>sample string 2</PatientLastName>
<VisitDateTime>2025-10-27T21:15:27.1741857+00:00</VisitDateTime>
<VisitID>sample string 6</VisitID>
</PatientInfo>
</PatientInfoList>
<Percentage>12</Percentage>
<PracticeID>sample string 2</PracticeID>
<Program>sample string 1</Program>
<ProviderID>sample string 3</ProviderID>
<ServiceErrorMessage>sample string 9</ServiceErrorMessage>
</ReportMetrics>