GET api/support/{practiceId}/clinical/practicecalendar?providerIds={providerIds}&from={from}&days={days}

Get calendar information from mymps system ( etc)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

doctor id in DrApp system

 globally unique identifier

Required
providerIds

comma delimited string of provider Ids

 string

Required
from

date

Required
days

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Collection of Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model.CalendarEventVo
NameDescriptionTypeAdditional information
CalendarEventXRef

string

None.
PatientName

string

None.
PatientXRef

string

None.
PatientId

globally unique identifier

None.
PatientSurname

string

None.
BenefitCheckStatus

string

None.
AppointmentTitle

string

None.
AppointmentType

string

None.
AppointmentStatus

string

None.
AppointmentReason

string

None.
Invoiced

boolean

None.
StartDate

date

None.
EndDate

date

None.
PracticeId

globally unique identifier

None.
Type

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CalendarEventXRef": "sample string 1",
    "PatientName": "sample string 2",
    "PatientXRef": "sample string 3",
    "PatientId": "f9328b64-bcfe-4580-a408-398a4b377c13",
    "PatientSurname": "sample string 4",
    "BenefitCheckStatus": "sample string 5",
    "AppointmentTitle": "sample string 6",
    "AppointmentType": "sample string 7",
    "AppointmentStatus": "sample string 8",
    "AppointmentReason": "sample string 9",
    "Invoiced": true,
    "StartDate": "2025-04-21T23:10:48Z",
    "EndDate": "2025-04-21T23:10:48Z",
    "PracticeId": "b611063f-5372-433b-bfed-e7de9979499d",
    "Type": "sample string 13"
  },
  {
    "CalendarEventXRef": "sample string 1",
    "PatientName": "sample string 2",
    "PatientXRef": "sample string 3",
    "PatientId": "f9328b64-bcfe-4580-a408-398a4b377c13",
    "PatientSurname": "sample string 4",
    "BenefitCheckStatus": "sample string 5",
    "AppointmentTitle": "sample string 6",
    "AppointmentType": "sample string 7",
    "AppointmentStatus": "sample string 8",
    "AppointmentReason": "sample string 9",
    "Invoiced": true,
    "StartDate": "2025-04-21T23:10:48Z",
    "EndDate": "2025-04-21T23:10:48Z",
    "PracticeId": "b611063f-5372-433b-bfed-e7de9979499d",
    "Type": "sample string 13"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCalendarEventVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model">
  <CalendarEventVo>
    <AppointmentReason>sample string 9</AppointmentReason>
    <AppointmentStatus>sample string 8</AppointmentStatus>
    <AppointmentTitle>sample string 6</AppointmentTitle>
    <AppointmentType>sample string 7</AppointmentType>
    <BenefitCheckStatus>sample string 5</BenefitCheckStatus>
    <CalendarEventXRef>sample string 1</CalendarEventXRef>
    <EndDate>2025-04-21T23:10:48.1194796+02:00</EndDate>
    <Invoiced>true</Invoiced>
    <PatientId>f9328b64-bcfe-4580-a408-398a4b377c13</PatientId>
    <PatientName>sample string 2</PatientName>
    <PatientSurname>sample string 4</PatientSurname>
    <PatientXRef>sample string 3</PatientXRef>
    <PracticeId>b611063f-5372-433b-bfed-e7de9979499d</PracticeId>
    <StartDate>2025-04-21T23:10:48.1194796+02:00</StartDate>
    <Type>sample string 13</Type>
  </CalendarEventVo>
  <CalendarEventVo>
    <AppointmentReason>sample string 9</AppointmentReason>
    <AppointmentStatus>sample string 8</AppointmentStatus>
    <AppointmentTitle>sample string 6</AppointmentTitle>
    <AppointmentType>sample string 7</AppointmentType>
    <BenefitCheckStatus>sample string 5</BenefitCheckStatus>
    <CalendarEventXRef>sample string 1</CalendarEventXRef>
    <EndDate>2025-04-21T23:10:48.1194796+02:00</EndDate>
    <Invoiced>true</Invoiced>
    <PatientId>f9328b64-bcfe-4580-a408-398a4b377c13</PatientId>
    <PatientName>sample string 2</PatientName>
    <PatientSurname>sample string 4</PatientSurname>
    <PatientXRef>sample string 3</PatientXRef>
    <PracticeId>b611063f-5372-433b-bfed-e7de9979499d</PracticeId>
    <StartDate>2025-04-21T23:10:48.1194796+02:00</StartDate>
    <Type>sample string 13</Type>
  </CalendarEventVo>
</ArrayOfCalendarEventVo>