Appointments

Book & Manage appointments for patients.

Book Appointment

POST https://consult.demo.medeintegra.dev/appointments/create

API to book an appointment for the patient.

Headers

Name	Type	Description
Authorization	string	Bearer <<ACCESS_TOKEN>>

Request Body

Name	Type	Description
bookingType	string	Type of booking like immediate, regular
communicationChannel	string	Communication medium for the appointment with the doctor, Ex: Video
reason	string	The Short reason for booking the appointment
patientInfo	object	Patient basic details

200 Appointment will be booked with some extra information like case sheet details and consult details

{
    "message" : "Appointment created Successfully"
    "status": "success",
    "data": {
			"patientInfo": {
				"patientId": "UHID_test_2",
				"firstName": "Krew",
				"lastName": "Max",
				"age": "27",
				"gender": "male",
				"email": "[email protected]",
				"phone": "[phone]",
				"dp": "url"
			},
			"bookedBy": "Self",
			"reason": "Cold and Cough",
			"doctorInfo": {
				"doctorId": "doctor Id",
				"speciality": ["speciality"],
				"name": "Doctor name"
			},
			"communicationChannel": "Video",
			"scheduledAt": 1592441432,
			"casesheetInfo": {
				"casesheetId": "mede_casesheet_id"
			},
			"videoCallInfo": {
				"roomId": "mede_room_id"
			},
			"appointmentId": "mede_appointment_id",
			"status": "Booked"
		}
}

404 Not found

Sample patientInfo	
	{
			"patientId": "UHID_test_2",
			"firstName": "Krew",
			"lastName": "Max",
			"age": "27",
			"gender": "male",
			"email": "[email protected]",
			"phone": "[phone]",
			"dp": "url"
	}

Sample Request

{
    "patientInfo": {
        "patientId": "patientId_123",
        "firstName": "Patient",
        "lastName": "Name",
        "ageInEpoch": 725328000,
        "gender": "Male",
        "email": "[email protected]",
        "phone": "[phone]",
        "dp": "https://s.gravatar.com/avatar/76557add768f874499f73239b4c576ba?s=80"
    },
    "bookedBy": "Self",
    "bookingType": "IMMEDIATE",
    "reason": "Corona Effect",
    "communicationChannel": "Video",
    "webhook": {
    	"url": "https://webhook.clientapi.com/appointments/updates",
    	"authorization": "some-identifier"
    }
}

Sample Response

Appointment Details

GET https://consult.demo.medeintegra.dev/appointments/get/{id}

Path Parameters

Name	Type	Description
	string	the id is the appointment id

200

Booked

{
    "patientInfo": {
        "patientId": "patientId_123",
        "firstName": "Patient",
        "lastName": "Name",
        "ageInEpoch": 725328000,
        "gender": "Male",
        "email": "[email protected]",
        "phone": "[phone]",
        "dp": "https://s.gravatar.com/avatar/76557add768f874499f73239b4c576ba?s=80",
        "pin": "2694"
    },
    "bookedBy": "Self",
    "bookingType": "IMMEDIATE",
    "reason": "Corona Effect",
    "communicationChannel": "Video",
    "webhook": {
        "url": "https://webhook.clientapi.com/appointments/updates",
        "authorization": "some-identifier"
    },
    "casesheetInfo": {
        "casesheetId": "mede_casesheet_f8a7cf50-b13d-11ea-b721-2399ac305648"
    },
    "videoCallInfo": {
        "roomId": "mede_room_f8b738a0-b13d-11ea-ad41-bd705641ad2a",
        "patientRoomUrl": "https://mede-webrtc.web.app/video/room?roomId=mede_room_f8b738a0-b13d-11ea-ad41-bd705641ad2a&userId=patientId_123"
    },
    "appointmentId": "mede_appointment_ac7973dd-e6d1-4004-9f73-f7162d469e6b",
    "status": "Booked"
}

Confirmed

Closed

Transferred

Canceled

Discarded

Feedback

POST https://consult.demo.medeintegra.dev/appointments/:id/feedback

Save Feedback given by the Patient

Path Parameters

Name	Type	Description
id	string	Appointment Id

Request Body

Name	Type	Description
feedback	string	Feedback in a free form text
rating	number	A number 0 to 10

200

{
	"status": "success",
	"message": "Feedback updated successfully"
}

Cancel Appointment

POST https://consult.demo.medeintegra.dev/appointments/cancel/:id

Cancels the appointment whose appointment Id matches the path parameter id

Path Parameters

Name	Type	Description
id	string	appointment id that needs to be canceled

200 The Response contains the status of the cancellation, if it is a success the appointment has canceled successfully

{
        status: "success",
        message: "Appointment cancelled Successfully"
}