Patients
Retrieve a patient
Section titled “Retrieve a patient”Retrieve the details of an existing patient. You need only supply the unique patient identifier that was returned upon patient registration.
HTTP Request
Section titled “HTTP Request”GET {server_url}/api/v2/patients/{patient_id}
This request must include a valid User JWT token, please see our documentation.
Header Parameter
Section titled “Header Parameter”| Parameter | Default |
|---|---|
| Content-type | application/json |
| Authorization | Bearer {jwt_token} |
Request Body
Section titled “Request Body”The following parameters are required to retrieve a patient.
| Attribute | Required | Description |
|---|---|---|
| patient_id | true | ID of the patient to be retrieved |
Example Request
Section titled “Example Request”curl {server_url}/api/v2/patients/{patient_id}-H "Content-type: application/json"-H "Authorization: Bearer 34a2sample-user-token"RestClient::Request.new( :method => :get, :url => "{server_url}/api/v2/patients/{patient_id}", :headers => { "Content-type" => "application/json", "Authorization" => "Bearer 34a2sample-user-token" }).executeExample Response
Section titled “Example Response”{ "patient_profile": { "id": 42, "fullname": "John Doe", "email": "johndoe@md.com", "gender": "Male", "age": 32, "birthdate": "1985-09-15", "affiliation_id": 96, "security_id": null, "primary_care_physician": null, "unpaid_balance": 0, "user_status_id": 1, "username": "johndoe", "first_name": "John", "last_name": "Doe", "address1": "1 ST NW 1", "address2": null, "city": "Sunrise", "state_id": 10, "zip": "33324", "phone": "7866665555", "cell": null, "emergency_contact_number": null, "us_time_zone_id": 1, "language_id": null, "registered_date": null, "eligible_members": [ ], "parent_id": null, "magellan": false, "plan_id": 158, "therapy_enabled": false, "email_confirmed": true, "can_add_family_members": true, "assist_phone_number": "1-800-400-MDLIVE", "parent_authorized": false, "is_primary": true, "provider_types": [ [ 3, "Family Physician" ], [ 5, "Therapist" ], [ 6, "Psychiatrist" ], [ 12, "Dermatologist" ] ], "unread_message_count": 0, "primary_name": null, "customer_insurance_parent_detail": null, "chat_history_count": 0, "user_status": { "id": 1, "name": "Active", "updated_at": "2017-12-15 08:27:33 -0500", "created_at": "2017-12-15 08:27:33 -0500" }, "user_vip_flag": null, "customer_insurance_detail": null, "customer_detail": null, "customer_benefit_overuse": null, "affiliation": { "description": "DTC", "id": 96, "video_only": false, "is_ccp": false, "epic_enabled": false, "affiliated_doctors_only": false, "disallow_membership_card": true, "activation_date": null, "deactivated_date": null, "dependent_registration_disabled": [ ], "affiliated_providers_only_for_agents": false, "verify_eligibility": false, "name": "DTC", "pharmacy_disabled": false, "allow_add_family_members": true, "request_appointment_enabled": true, "phone_only": false, "breakthrough_enabled": false, "dtc_insurance_enabled": false, "insurance_payer": null, "privacy_policy_text":"{privacy_policy_text}", "informed_consent_text":"{informed_consent_text}", "privacy_policy_question":"I have read MDLIVE Medical Group's Privacy Policy and I acknowledge that I have the ability to print a hard copy of the Privacy Policy for my records.", "informed_consent_question":"I certify that I have read and accept the terms of MDLIVE Medical Group's Informed Consent." }, "state": { "name": "FLORIDA", "id": 10 }, "pharmacy": { "id": 1, "name": "CVS/pharmacy #7900", "city": "SUNRISE", "address1": "10000 W COMMERCIAL BLVD", "address2": "", "state": "FL", "zipcode": "33351", "phone": "9547486377", "fax": "9547486435", "latitude": 26.1935, "longitude": -80.2846, "twenty_four_hour_flag": false }, "recent_notes": [ ], "family_members": [ { "id": 3, "fullname": "John Doe", "email": "johndoe@md.com", "gender": "Male", "age": 32, "birthdate": "1987-09-15", "user_status_id": 1, "parent_id": null, "username": "johndoe", "first_name": "John", "last_name": "Doe", "address1": "1 ST NW 1", "address2": null, "city": "Sunrise", "state_id": 10, "zip": "33324", "phone": "7866665555", "cell": null, "emergency_contact_number": null, "us_time_zone_id": 1, "language_id": null, "is_authorized": false, "is_active": true, "email_confirmed": true, "image_url": "" } ], "recent_activity_histories": [ ], "chat_histories": [ ], "upcoming_appointments": [ ], "completed_appointments": [ ], "pending_update_appointments": [ ], "requested_appointments": [ ] }}Update a patient
Section titled “Update a patient”Update patient related information.
HTTP Request
Section titled “HTTP Request”PATCH {server_url}/api/v2/patients/{patient_id}
This request must include a valid User JWT token, please see our documentation.
Header Parameter
Section titled “Header Parameter”| Parameter | Default |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| Authorization | Bearer {jwttoken} |
Request Body
Section titled “Request Body”The following parameters are required to retrieve a patient.
| Attribute | Required | Description |
|---|---|---|
| patient_id | true | ID of the patient to be retrieved |
Request Body Parameters
Section titled “Request Body Parameters”| Attribute | Required | Description |
|---|---|---|
| patient | true | parent attribute for the patient |
| ↳ first_name | false | Patient’s first name |
| ↳ last_name | false | Patient’s last name |
| ↳ gender | false | Patient’s gender, specified as ‘M’ for male, ‘F’ for female |
| ↳ birthdate | false | Patient’s birthdate, specified as year-month-day |
| ↳ phone | false | Patient’s contact phone number |
| ↳ cell | false | Patient’s mobile phone number |
| ↳ emergency_contact_number | false | Patient’s emergency contact phone number |
| false | Patient’s email address | |
| ↳ address1 | false | First line of Patient’s mailing address |
| ↳ address2 | false | Second line of Patient’s mailing address, if needed |
| ↳ city | false | City of Patient’s mailing address |
| ↳ state_id | false | State ID of Patient’s mailing address (See documentation |
| ↳ zip | false | Zip code of Patient’s mailing address |
| ↳ pharmacy_id | false | Pharmacy ID of Patient’s pharmacy (See documentation |
Example Request
Section titled “Example Request”curl -X PATCH {server_url}/api/v2/patients/{patient_id} \ -H "Content-type: application/json" \ -H "Authorization: Bearer {jwt_token}" \ -H "Accept: application/json" \ -d '{ "patient": { "first_name": "Test", "last_name": "Patient" } }'RestClient::Request.new( :method => :patch, :url => "{server_url}/api/v2/patients/{patient_id}", :headers => { "Content-type" => "application/json", "Authorization" => "Bearer {jwt_token}", "Accept" => "application/json" }, :payload => { patient: { first_name: "Test", last_name: "Patient" } }).executeExample Response
Section titled “Example Response”{ "patient_profile": { "id": 42, "fullname": "Test Patient", "email": "johndoe@md.com", "gender": "Male", "age": 32, "birthdate": "1985-09-15", "affiliation_id": 96, "security_id": null, "primary_care_physician": null, "unpaid_balance": 0, "user_status_id": 1, "username": "johndoe", "first_name": "Test", "last_name": "Patient", "address1": "1 ST NW 1", "address2": null, "city": "Sunrise", "state_id": 10, "zip": "33324", "phone": "7866665555", "cell": null, "emergency_contact_number": null, "us_time_zone_id": 1, "language_id": null, "registered_date": null, "eligible_members": [ ], "parent_id": null, "magellan": false, "plan_id": 158, "therapy_enabled": false, "email_confirmed": true, "can_add_family_members": true, "assist_phone_number": "1-800-400-MDLIVE", "parent_authorized": false, "is_primary": true, "provider_types": [ [ 3, "Family Physician" ], [ 5, "Therapist" ], [ 6, "Psychiatrist" ], [ 12, "Dermatologist" ] ], "unread_message_count": 0, "primary_name": null, "customer_insurance_parent_detail": null, "chat_history_count": 0, "user_status": { "id": 1, "name": "Active", "updated_at": "2017-12-15 08:27:33 -0500", "created_at": "2017-12-15 08:27:33 -0500" }, "user_vip_flag": null, "customer_insurance_detail": null, "customer_detail": null, "customer_benefit_overuse": null, "affiliation": { "description": "DTC", "id": 96, "video_only": false, "is_ccp": false, "epic_enabled": false, "affiliated_doctors_only": false, "disallow_membership_card": true, "activation_date": null, "deactivated_date": null, "dependent_registration_disabled": [ ], "affiliated_providers_only_for_agents": false, "verify_eligibility": false, "name": "DTC", "pharmacy_disabled": false, "allow_add_family_members": true, "request_appointment_enabled": true, "phone_only": false, "breakthrough_enabled": false, "dtc_insurance_enabled": false, "insurance_payer": null, "privacy_policy_text":"{privacy_policy_text}", "informed_consent_text":"{informed_consent_text}", "privacy_policy_question":"I have read MDLIVE Medical Group's Privacy Policy and I acknowledge that I have the ability to print a hard copy of the Privacy Policy for my records.", "informed_consent_question":"I certify that I have read and accept the terms of MDLIVE Medical Group's Informed Consent." }, "state": { "name": "FLORIDA", "id": 10 }, "pharmacy": { "id": 1, "name": "CVS/pharmacy #7900", "city": "SUNRISE", "address1": "10000 W COMMERCIAL BLVD", "address2": "", "state": "FL", "zipcode": "33351", "phone": "9547486377", "fax": "9547486435", "latitude": 26.1935, "longitude": -80.2846, "twenty_four_hour_flag": false }, "recent_notes": [ ], "family_members": [ { "id": 3, "fullname": "John Doe", "email": "johndoe@md.com", "gender": "Male", "age": 32, "birthdate": "1987-09-15", "user_status_id": 1, "parent_id": null, "username": "johndoe", "first_name": "John", "last_name": "Doe", "address1": "1 ST NW 1", "address2": null, "city": "Sunrise", "state_id": 10, "zip": "33324", "phone": "7866665555", "cell": null, "emergency_contact_number": null, "us_time_zone_id": 1, "language_id": null, "is_authorized": false, "is_active": true, "email_confirmed": true, "image_url": "" } ], "recent_activity_histories": [ ], "chat_histories": [ ], "upcoming_appointments": [ ] }}