GET Health Maintenance Events

Developer Tools

GET api/v1/{EMRSystem}/HealthMaintenanceEvents

Returns both pending and completed Health Maintenance Events for a given patient.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

StartDateTime

Gets or sets start date time.

date

None

EndDateTime

Gets or sets end date time.

date

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing HealthMaintenanceEvents Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

PatientId

Gets or sets the patient identifier.

string

None.

HealthMaintenanceReminders

Gets or sets the health maintenance reminders.

Collection of HealthMaintenanceReminderViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.HealthMaintenanceEventsResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
{
  "PatientId": "sample string 1",
  "HealthMaintenanceReminders": [
    {
      "ReminderId": "sample string 1",
      "ReminderName": "sample string 2",
      "ReminderStatus": "sample string 3",
      "ReminderDueDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderStartDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderEndDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderLastSatisfyDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderLastSatisfyProvider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "ReminderPriority": "sample string 4",
      "ReminderComment": "sample string 5",
      "ReminderFrequency": "sample string 6",
      "ReminderFrequencyUnit": "sample string 7",
      "HealthMaintenceHistories": [
        {
          "HistoryId": "sample string 1",
          "HistoryName": "sample string 2",
          "HistoryCode": "sample string 3",
          "HistoryReason": "sample string 4",
          "HistoryReasonCode": "sample string 5",
          "HistoryProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "HistoryDateTime": "2018-02-14T14:19:37.2330229Z",
          "HistoryComment": "sample string 6"
        },
        {
          "HistoryId": "sample string 1",
          "HistoryName": "sample string 2",
          "HistoryCode": "sample string 3",
          "HistoryReason": "sample string 4",
          "HistoryReasonCode": "sample string 5",
          "HistoryProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "HistoryDateTime": "2018-02-14T14:19:37.2330229Z",
          "HistoryComment": "sample string 6"
        }
      ]
    },
    {
      "ReminderId": "sample string 1",
      "ReminderName": "sample string 2",
      "ReminderStatus": "sample string 3",
      "ReminderDueDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderStartDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderEndDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderLastSatisfyDateTime": "2018-02-14T14:19:37.2330229Z",
      "ReminderLastSatisfyProvider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "ReminderPriority": "sample string 4",
      "ReminderComment": "sample string 5",
      "ReminderFrequency": "sample string 6",
      "ReminderFrequencyUnit": "sample string 7",
      "HealthMaintenceHistories": [
        {
          "HistoryId": "sample string 1",
          "HistoryName": "sample string 2",
          "HistoryCode": "sample string 3",
          "HistoryReason": "sample string 4",
          "HistoryReasonCode": "sample string 5",
          "HistoryProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "HistoryDateTime": "2018-02-14T14:19:37.2330229Z",
          "HistoryComment": "sample string 6"
        },
        {
          "HistoryId": "sample string 1",
          "HistoryName": "sample string 2",
          "HistoryCode": "sample string 3",
          "HistoryReason": "sample string 4",
          "HistoryReasonCode": "sample string 5",
          "HistoryProvider": {
            "ProviderId": "sample string 1",
            "ProviderName": "sample string 2"
          },
          "HistoryDateTime": "2018-02-14T14:19:37.2330229Z",
          "HistoryComment": "sample string 6"
        }
      ]
    }
  ]
}
Sample Message
<HealthMaintenanceEventsResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <HealthMaintenanceReminders xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:HealthMaintenanceReminderViewModel>
      <d2p1:HealthMaintenceHistories>
        <d2p1:HealthMaintenanceHistoryViewModel>
          <d2p1:HistoryCode>sample string 3</d2p1:HistoryCode>
          <d2p1:HistoryComment>sample string 6</d2p1:HistoryComment>
          <d2p1:HistoryDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:HistoryDateTime>
          <d2p1:HistoryId>sample string 1</d2p1:HistoryId>
          <d2p1:HistoryName>sample string 2</d2p1:HistoryName>
          <d2p1:HistoryProvider>
            <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          </d2p1:HistoryProvider>
          <d2p1:HistoryReason>sample string 4</d2p1:HistoryReason>
          <d2p1:HistoryReasonCode>sample string 5</d2p1:HistoryReasonCode>
        </d2p1:HealthMaintenanceHistoryViewModel>
        <d2p1:HealthMaintenanceHistoryViewModel>
          <d2p1:HistoryCode>sample string 3</d2p1:HistoryCode>
          <d2p1:HistoryComment>sample string 6</d2p1:HistoryComment>
          <d2p1:HistoryDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:HistoryDateTime>
          <d2p1:HistoryId>sample string 1</d2p1:HistoryId>
          <d2p1:HistoryName>sample string 2</d2p1:HistoryName>
          <d2p1:HistoryProvider>
            <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          </d2p1:HistoryProvider>
          <d2p1:HistoryReason>sample string 4</d2p1:HistoryReason>
          <d2p1:HistoryReasonCode>sample string 5</d2p1:HistoryReasonCode>
        </d2p1:HealthMaintenanceHistoryViewModel>
      </d2p1:HealthMaintenceHistories>
      <d2p1:ReminderComment>sample string 5</d2p1:ReminderComment>
      <d2p1:ReminderDueDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderDueDateTime>
      <d2p1:ReminderEndDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderEndDateTime>
      <d2p1:ReminderFrequency>sample string 6</d2p1:ReminderFrequency>
      <d2p1:ReminderFrequencyUnit>sample string 7</d2p1:ReminderFrequencyUnit>
      <d2p1:ReminderId>sample string 1</d2p1:ReminderId>
      <d2p1:ReminderLastSatisfyDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderLastSatisfyDateTime>
      <d2p1:ReminderLastSatisfyProvider>
        <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
      </d2p1:ReminderLastSatisfyProvider>
      <d2p1:ReminderName>sample string 2</d2p1:ReminderName>
      <d2p1:ReminderPriority>sample string 4</d2p1:ReminderPriority>
      <d2p1:ReminderStartDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderStartDateTime>
      <d2p1:ReminderStatus>sample string 3</d2p1:ReminderStatus>
    </d2p1:HealthMaintenanceReminderViewModel>
    <d2p1:HealthMaintenanceReminderViewModel>
      <d2p1:HealthMaintenceHistories>
        <d2p1:HealthMaintenanceHistoryViewModel>
          <d2p1:HistoryCode>sample string 3</d2p1:HistoryCode>
          <d2p1:HistoryComment>sample string 6</d2p1:HistoryComment>
          <d2p1:HistoryDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:HistoryDateTime>
          <d2p1:HistoryId>sample string 1</d2p1:HistoryId>
          <d2p1:HistoryName>sample string 2</d2p1:HistoryName>
          <d2p1:HistoryProvider>
            <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          </d2p1:HistoryProvider>
          <d2p1:HistoryReason>sample string 4</d2p1:HistoryReason>
          <d2p1:HistoryReasonCode>sample string 5</d2p1:HistoryReasonCode>
        </d2p1:HealthMaintenanceHistoryViewModel>
        <d2p1:HealthMaintenanceHistoryViewModel>
          <d2p1:HistoryCode>sample string 3</d2p1:HistoryCode>
          <d2p1:HistoryComment>sample string 6</d2p1:HistoryComment>
          <d2p1:HistoryDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:HistoryDateTime>
          <d2p1:HistoryId>sample string 1</d2p1:HistoryId>
          <d2p1:HistoryName>sample string 2</d2p1:HistoryName>
          <d2p1:HistoryProvider>
            <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
          </d2p1:HistoryProvider>
          <d2p1:HistoryReason>sample string 4</d2p1:HistoryReason>
          <d2p1:HistoryReasonCode>sample string 5</d2p1:HistoryReasonCode>
        </d2p1:HealthMaintenanceHistoryViewModel>
      </d2p1:HealthMaintenceHistories>
      <d2p1:ReminderComment>sample string 5</d2p1:ReminderComment>
      <d2p1:ReminderDueDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderDueDateTime>
      <d2p1:ReminderEndDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderEndDateTime>
      <d2p1:ReminderFrequency>sample string 6</d2p1:ReminderFrequency>
      <d2p1:ReminderFrequencyUnit>sample string 7</d2p1:ReminderFrequencyUnit>
      <d2p1:ReminderId>sample string 1</d2p1:ReminderId>
      <d2p1:ReminderLastSatisfyDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderLastSatisfyDateTime>
      <d2p1:ReminderLastSatisfyProvider>
        <d2p1:ProviderId>sample string 1</d2p1:ProviderId>
        <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
      </d2p1:ReminderLastSatisfyProvider>
      <d2p1:ReminderName>sample string 2</d2p1:ReminderName>
      <d2p1:ReminderPriority>sample string 4</d2p1:ReminderPriority>
      <d2p1:ReminderStartDateTime>2018-02-14T08:19:37.2330229-06:00</d2p1:ReminderStartDateTime>
      <d2p1:ReminderStatus>sample string 3</d2p1:ReminderStatus>
    </d2p1:HealthMaintenanceReminderViewModel>
  </HealthMaintenanceReminders>
  <PatientId>sample string 1</PatientId>
</HealthMaintenanceEventsResponseViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?