GET api/v1/{EMRSystem}/HealthMaintenanceEvents

Returns both pending and completed Health Maintenance Events for a given patient. FHIR connectors use the following resources for R4: Careplan.Search and Patient.Read.

Status: Released

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
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.	datetime	None.
EndDateTime	Gets or sets end date time.	datetime	None.

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

UdmHealthMaintenanceEventsResponse

Name	Description	Type	Additional information
PatientId	Gets or sets the patient identifier.	string	None.
HealthMaintenanceReminders	Gets or sets the health maintenance reminders.	Collection of HealthMaintenanceReminder	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

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

application/json

{
  "PatientId": "sample string 1",
  "HealthMaintenanceReminders": [
    {
      "ReminderId": "sample string 1",
      "ReminderName": "sample string 2",
      "ReminderStatus": "sample string 3",
      "ReminderDueDateTime": "2025-12-12T21:07:09.2567403+00:00",
      "ReminderStartDateTime": "2025-12-12T21:07:09.2567914+00:00",
      "ReminderEndDateTime": "2025-12-12T21:07:09.2568244+00:00",
      "ReminderLastSatisfyDateTime": "2025-12-12T21:07:09.2568563+00:00",
      "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": "2025-12-12T21:07:09.2591553+00:00",
          "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": "2025-12-12T21:07:09.2591553+00:00",
          "HistoryComment": "sample string 6"
        }
      ]
    },
    {
      "ReminderId": "sample string 1",
      "ReminderName": "sample string 2",
      "ReminderStatus": "sample string 3",
      "ReminderDueDateTime": "2025-12-12T21:07:09.2567403+00:00",
      "ReminderStartDateTime": "2025-12-12T21:07:09.2567914+00:00",
      "ReminderEndDateTime": "2025-12-12T21:07:09.2568244+00:00",
      "ReminderLastSatisfyDateTime": "2025-12-12T21:07:09.2568563+00:00",
      "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": "2025-12-12T21:07:09.2591553+00:00",
          "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": "2025-12-12T21:07:09.2591553+00:00",
          "HistoryComment": "sample string 6"
        }
      ]
    }
  ]
}

GET api/v1/{EMRSystem}/HealthMaintenanceEvents

Returns both pending and completed Health Maintenance Events for a given patient. FHIR connectors use the following resources for R4: Careplan.Search and Patient.Read.

Status: Released

URI Parameters

EMRSystem

Required

UserId

Required

PatientId

Required

StartDateTime

EndDateTime

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```