GET Appointment/GetAppointmentsAsync?patientId={patientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AppointmentInfo

Name	Type	Additional information
Endpoint_identifier	string	None.
Encounter_reference	string	None.
Healthcareservice_reference	string	None.
Healthcareservice_display	string	None.
Servicetype_code	string	None.
Servicetype_display	string	None.
Practitioner_reference	string	None.
Practitioner_display	string	None.
Patient_reference	string	None.
Patient_display	string	None.
Location_reference	string	None.
Location_display	string	None.
Organization_reference	string	None.
Organization_display	string	None.
Appointmentdate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Endpoint_identifier": "sample string 1",
    "Encounter_reference": "sample string 2",
    "Healthcareservice_reference": "sample string 3",
    "Healthcareservice_display": "sample string 4",
    "Servicetype_code": "sample string 5",
    "Servicetype_display": "sample string 6",
    "Practitioner_reference": "sample string 7",
    "Practitioner_display": "sample string 8",
    "Patient_reference": "sample string 9",
    "Patient_display": "sample string 10",
    "Location_reference": "sample string 11",
    "Location_display": "sample string 12",
    "Organization_reference": "sample string 13",
    "Organization_display": "sample string 14",
    "Appointmentdate": "2025-09-04T13:41:12.4809134+00:00"
  },
  {
    "Endpoint_identifier": "sample string 1",
    "Encounter_reference": "sample string 2",
    "Healthcareservice_reference": "sample string 3",
    "Healthcareservice_display": "sample string 4",
    "Servicetype_code": "sample string 5",
    "Servicetype_display": "sample string 6",
    "Practitioner_reference": "sample string 7",
    "Practitioner_display": "sample string 8",
    "Patient_reference": "sample string 9",
    "Patient_display": "sample string 10",
    "Location_reference": "sample string 11",
    "Location_display": "sample string 12",
    "Organization_reference": "sample string 13",
    "Organization_display": "sample string 14",
    "Appointmentdate": "2025-09-04T13:41:12.4809134+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAppointmentInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppointmentAPI.Entities">
  <AppointmentInfo>
    <_x003C_Appointmentdate_x003E_k__BackingField>2025-09-04T13:41:12.4809134+00:00</_x003C_Appointmentdate_x003E_k__BackingField>
    <_x003C_Encounter_reference_x003E_k__BackingField>sample string 2</_x003C_Encounter_reference_x003E_k__BackingField>
    <_x003C_Endpoint_identifier_x003E_k__BackingField>sample string 1</_x003C_Endpoint_identifier_x003E_k__BackingField>
    <_x003C_Healthcareservice_display_x003E_k__BackingField>sample string 4</_x003C_Healthcareservice_display_x003E_k__BackingField>
    <_x003C_Healthcareservice_reference_x003E_k__BackingField>sample string 3</_x003C_Healthcareservice_reference_x003E_k__BackingField>
    <_x003C_Location_display_x003E_k__BackingField>sample string 12</_x003C_Location_display_x003E_k__BackingField>
    <_x003C_Location_reference_x003E_k__BackingField>sample string 11</_x003C_Location_reference_x003E_k__BackingField>
    <_x003C_Organization_display_x003E_k__BackingField>sample string 14</_x003C_Organization_display_x003E_k__BackingField>
    <_x003C_Organization_reference_x003E_k__BackingField>sample string 13</_x003C_Organization_reference_x003E_k__BackingField>
    <_x003C_Patient_display_x003E_k__BackingField>sample string 10</_x003C_Patient_display_x003E_k__BackingField>
    <_x003C_Patient_reference_x003E_k__BackingField>sample string 9</_x003C_Patient_reference_x003E_k__BackingField>
    <_x003C_Practitioner_display_x003E_k__BackingField>sample string 8</_x003C_Practitioner_display_x003E_k__BackingField>
    <_x003C_Practitioner_reference_x003E_k__BackingField>sample string 7</_x003C_Practitioner_reference_x003E_k__BackingField>
    <_x003C_Servicetype_code_x003E_k__BackingField>sample string 5</_x003C_Servicetype_code_x003E_k__BackingField>
    <_x003C_Servicetype_display_x003E_k__BackingField>sample string 6</_x003C_Servicetype_display_x003E_k__BackingField>
  </AppointmentInfo>
  <AppointmentInfo>
    <_x003C_Appointmentdate_x003E_k__BackingField>2025-09-04T13:41:12.4809134+00:00</_x003C_Appointmentdate_x003E_k__BackingField>
    <_x003C_Encounter_reference_x003E_k__BackingField>sample string 2</_x003C_Encounter_reference_x003E_k__BackingField>
    <_x003C_Endpoint_identifier_x003E_k__BackingField>sample string 1</_x003C_Endpoint_identifier_x003E_k__BackingField>
    <_x003C_Healthcareservice_display_x003E_k__BackingField>sample string 4</_x003C_Healthcareservice_display_x003E_k__BackingField>
    <_x003C_Healthcareservice_reference_x003E_k__BackingField>sample string 3</_x003C_Healthcareservice_reference_x003E_k__BackingField>
    <_x003C_Location_display_x003E_k__BackingField>sample string 12</_x003C_Location_display_x003E_k__BackingField>
    <_x003C_Location_reference_x003E_k__BackingField>sample string 11</_x003C_Location_reference_x003E_k__BackingField>
    <_x003C_Organization_display_x003E_k__BackingField>sample string 14</_x003C_Organization_display_x003E_k__BackingField>
    <_x003C_Organization_reference_x003E_k__BackingField>sample string 13</_x003C_Organization_reference_x003E_k__BackingField>
    <_x003C_Patient_display_x003E_k__BackingField>sample string 10</_x003C_Patient_display_x003E_k__BackingField>
    <_x003C_Patient_reference_x003E_k__BackingField>sample string 9</_x003C_Patient_reference_x003E_k__BackingField>
    <_x003C_Practitioner_display_x003E_k__BackingField>sample string 8</_x003C_Practitioner_display_x003E_k__BackingField>
    <_x003C_Practitioner_reference_x003E_k__BackingField>sample string 7</_x003C_Practitioner_reference_x003E_k__BackingField>
    <_x003C_Servicetype_code_x003E_k__BackingField>sample string 5</_x003C_Servicetype_code_x003E_k__BackingField>
    <_x003C_Servicetype_display_x003E_k__BackingField>sample string 6</_x003C_Servicetype_display_x003E_k__BackingField>
  </AppointmentInfo>
</ArrayOfAppointmentInfo>