GetMu2Metrics

Used to retrieve MU2 tracking events (metrics) data.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"GetMu2Metrics",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

Request

data has following elemetns:
patientId(string)Unique patient id.
providerId(string)Unique provider id.
eventStart(datetime)Filter by "from" datetime.
eventEnd(datetime)Filter by "to" datetime.
entityTypeId(int)Filter by entity type. See possible types below
actionTypeId(int)Filter by action type. See possible types below.
newOnly(bool)To get only items not marked as "read" (if set to "true" then all retrieved items will be marked as "read").
mu2Only(bool)Get only MU2 event (Sophrona may force this parameter to "true" to restrict access to non-MU2 eventes).
itemsPerCall(int)To limit number of items in a response (Sophrona has its own parameter. The minimal value will be used)
Notes:
  • All parameters are optional. If parameter is not provided then default value will be used.
  • if itemsPerCall parameter value exceeds Sophrona specified value, then Sophrona specified value will be used
  • entityType default value is 0 (all)
  • actionType default value is 0 (all)
  • newOnly default value is "true"
  • mu2Only default value is "true"
  • for XML serialization eventStart, eventEnd parameters must follow ISO8601 standard (i.e. "2017-03-15T15:28:26"). JSON can accept any format.
  • eventStart, eventEnd have time portion. If specified as date only, for example "1/31/2017" then such date will not be included. Specify it as "1/31/2017 23:59:59" to include
XML Example:
JSON Example:
{
    "patientId": "TS01831451",
    "providerId": "2",
    "eventStart": "\/Date(1470888000000)\/",
    "eventEnd": "\/Date(1473545961518)\/",
    "entityTypeId": 1,
    "actionTypeId": 0,
    "newOnly": false,
    "mu2Only": true,
    "itemsPerCall": 50 
}

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.

payload represents a list of MU2 event records. Each item is MU2MetricsItem .
XML Example:
JSON Example:
{
    "trackingEvents": [
        {
            "eventId": "7cf8ab89-a7db-44bd-b9e1-0473fbd68c66",
            "patientId": "TS01831451",
            "providerId": "2",
            "eventTime": "\/Date(1472246541542)\/",
            "entityTypeId": 1,
            "actionTypeId": 7,
            "isNew": true,
            "byAuthorizedUser": false
        },

        { "eventId": "d6fed959-aecd-48b7-9924-1531073e4b0b", "patientId": "TS01831451", "providerId": "2", "eventTime": "\/Date(1473421941542)\/", "entityTypeId": 1, "actionTypeId": 6, "isNew": false, "byAuthorizedUser": false }
    ]
}
Entity Types:
  • All = 0
  • PatientChart = 1 (MU2 actions 7,6,9,17,18,19)
  • ClinicalSummary = 2 (MU2 actions 7,6,9,17)
  • EducationDelivery = 3 (MU2 action 2)
  • SecureMessage = 4 (MU2 actions 1,17)
  • Patient = 5 (MU2 actions 11,20)
  • AuthorizedUser = 6
  • Recall = 7
  • SummaryOfCare = 8 (MU2 action 2)
  • SmokingCessation = 9 (MU2 action 2)
  • PreventativeCare = 10 (MU2 action 2)
  • BreviumRecall = 11
  • Enrollment = 12
Action Types:
  • All = 0
  • Received = 1
  • NotificationQueued = 2
  • NotificationSent = 3
  • NotificationDelivered = 4
  • NotificationResponded = 5
  • Downloaded = 6
  • Viewed = 7
  • ChartTransmitRequested = 8
  • ChartTransmitted = 9
  • LoggedIn = 10
  • Patient Registration completed = 11
  • InvitationRequested = 12
  • InvitationSent = 13
  • InvitationRejected = 14
  • Authorized = 15
  • Suspended = 16
  • Sent = 17
  • Application Access - All = 18
  • Application Access - Category = 19
  • Patient Generated Health Data (PGHD) = 20
  • VDT = -2 (Special case - aggregate counter for View, Download and Transmit actions all together)

Notes:

All examples of source code and compiled version of SageBridge API client can be found here.

Known Issues:

None

See Also:

API Functions, APIResponse structure, MU2MetricsItem data