GET api/support/{practiceId}/clinical/calendar/details/{appointmentXRef}

Get appointment details from mymps system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
appointmentXRef

Mps AppointmentId, could also be CalendarEventXRef

 string

Required

Body Parameters

None.

Response Information

Resource Description

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model.AppointmentDetailsVo
NameDescriptionTypeAdditional information
AppointmentStatus

string

None.
AppointmentType

string

None.
AppointmentXRef

string

None.
PatientXRef

string

None.
VideoConsultLink

string

None.
VisitReason

string

None.
StartDate

date

None.
EndDate

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "AppointmentStatus": "sample string 1",
  "AppointmentType": "sample string 2",
  "AppointmentXRef": "sample string 3",
  "PatientXRef": "sample string 4",
  "VideoConsultLink": "sample string 5",
  "VisitReason": "sample string 6",
  "StartDate": "2025-04-12T11:33:13Z",
  "EndDate": "2025-04-12T11:33:13Z"
}

application/xml, text/xml

Sample: 
<AppointmentDetailsVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.ExternalSystemIntegration.Model">
  <AppointmentStatus>sample string 1</AppointmentStatus>
  <AppointmentType>sample string 2</AppointmentType>
  <AppointmentXRef>sample string 3</AppointmentXRef>
  <EndDate>2025-04-12T11:33:13.6864377+02:00</EndDate>
  <PatientXRef>sample string 4</PatientXRef>
  <StartDate>2025-04-12T11:33:13.6864377+02:00</StartDate>
  <VideoConsultLink>sample string 5</VideoConsultLink>
  <VisitReason>sample string 6</VisitReason>
</AppointmentDetailsVo>