Skip to content
MDLIVE logoMDLIVE logoMDLIVE Integrations

Eligibility API - Functionality

No. Item                                             Value
1 Functionality Add New Member
2 Description Use this method to add eligibility data for a new patient.
3 Path /members/
4 Request Method POST
5 Required Parameters 1. first_name (first name of patient)
2. last_name (last name of patient)
3. gender (Male or Female)
4. birthdate (in DD-MM-YYYY format)
5. phone (primary phone number of patient)
6. email (primary email id of patient)
7. address1 (address line 1)
8. city (city of the patient)
9. state (2 letter state code)
10. zip (zip code)
6 Conditional Parameters 1. external_id
      This is a unique identifier for the member in your system.
      The external_id can be something like SSN or member id or anything else which can be used to uniquely identify the member in your system/database.
      Required for adding primary members, and is desired but can be skipped when adding dependents.
2. plan_identifier
      An identifier indicating which plan should be assigned to the patient.
      Required if there are multiple plans associated with the API user.
3. parent_id
      Required for adding dependents.
      Should contain ID of the primary patient.
7 Optional Parameters 1. address2 (Address line 2)
2. emergency_contact (Emergency contact number)
3. work_phone (Work or office phone if available)
4. cell (Mobile number if available)
5. reporting1
      Any attribute that you want to be able to store and run reports on later.
      This is not used within MDLIVE system and is purely for storing additional information if required for the API consumer.
6. reporting2 (Same as reporting1)
7. reporting3 (Same as reporting1)
8. reporting4 (Same as reporting1)
9. subscriber_id (Subscriber ID of the member, including any suffix/prefix.)
10. insurance_group_number (Group number/ID of the insurance plan the member is on.)
8 Response Status Response status will be 201 if the request is successful.
      JSON representation of member data containing the “id” field assigned by MDLIVE system.
      This id should be stored by the client applications as it is required for other API methods.
See Errors section for details on errors.
9 Request Example
   - Add a Primary		 Request: external_id is required for adding a primary member.
   POST https://members.MDLIVE.com/services/members
            {
                  “member”: {
                        “external_id”: “guid-123-abc-xyz”,
                        “first_name”: “John”,
                        “last_name”: “Smith”,
                        “gender”: “Male”,
                        “birthdate”: “25-06-1989”,
                        “phone”: “8004006354”,
                        “email”: “test@mdlive.com”,
                        “address1”: “123 Test Road”,
                        “city”: “Sunrise”,
                        “state”: “FL”,
                        “zip”: “33325”
                  }
            }
10 Response Example
   - Add a Primary		 Response:
   The id (MDLIVE ID) is assigned by MDLIVE system when the eligibility data of this patient was created.
   This id (MDLIVE ID) should be stored by the client applications as it is required for other API methods.
   This id (MDLIVE ID) will be used to add dependents under this primary account.
   {
         “member”: {
                  “id”: 1000001,
                  “status”: “active”,
                  “first_name”: “John”,
                  “last_name”: “Smith”,
                  “gender”: “Male”,
                  “birthdate”: “25-06-89”,
                  “phone”: “8004006354”,
                  “email”: “test@mdlive.com”,
                  “address1”: “123 Test Road”,
                  “address2”: null,
                  “city”: “Sunrise”,
                  “state”: “FL”,
                  “zip”: “33325”,
                  “country”: “US”,
                  “emergency_contact_number”: null,
                  “reporting1”: null,
                  “reporting2”: null,
                  “reporting3”: null,
                  “reporting4”: null,
                  “parent_id”: null
         }
   }
11 Request Example
   - Add a Dependent		 Request: parent_id is required for adding a dependent member.
   POST https://members.MDLIVE.com/services/members
            {
                  “member”: {
                        “parent_id”: “1000001”,
                        “first_name”: “Baby”,
                        “last_name”: “Smith”,
                        “gender”: “Female”,
                        “birthdate”: “15-10-2010”,
                        “phone”: “8004006354”,
                        “email”: “test@mdlive.com”,
                        “address1”: “123 Test Road”,
                        “city”: “Sunrise”,
                        “state”: “FL”,
                        “zip”: “33325”
                  }
            }
No. Item Value
1 Functionality Read Existing Member Information
2 Description Use this method to get eligibility data for an existing patient as stored on MDLIVE system.
3 Path /members/id/
4 Request Method GET
5 Required Parameters id: The MDLIVE ID assigned by MDLIVE system when the eligibility data of this patient was created.
This should be set in the path.
6 Response Status Response status will be 200 if the request is successful.
      JSON representation of member data containing the “status” field to show the member’s current activation status.
Same as Create Member method.
See Errors section for details on errors.
7 Example
   - Read Member Information		 Request:
   GET https://members.mdlive.com/services/members/2
Response:
   Same as Create Member method
No. Item Value
1 Functionality Update Existing Member
2 Description Use this method to modify eligibility data for an existing patient.
3 Path /members/id/
4 Request Method PUT
5 Required Parameters id: The MDLIVE ID assigned by MDLIVE system when the eligibility data of this patient was created.
This should be set in the path.
6 Optional Parameters All required or optional parameters from the “Create Member” API Method
7 Response Status Response status will be 204 if the request is successful.
Same as Create Member method.
See Errors section for details on errors.
8 Example
   - Update Member		 Request:
   PUT https://members.mdlive.com/services/members/2
            {
                  “member”: {
                        “last_name”: “Smith”
                  }
            }
Response:
   Same as Create Member method
No. Item Value
1 Functionality Deactivate Existing Member
2 Description Use this method to deactivated an existing patient.
3 Path /members/id/
4 Request Method DELETE
5 Required Parameters id: The MDLIVE ID assigned by MDLIVE system when the eligibility data of this patient was created.
This should be set in the path.
6 Response Status Response status will be 204 if the request is successful.
No content is returned from the server just the response status.
See Errors section for details on errors.
7 Example
   - Deactivate Member		 Request:
   DELETE https://members.mdlive.com/services/members/2
Response:
   No Content
No. Item Value
1 Functionality Reactivate Existing Member
2 Description Use this method to re-activate a deactivated patient.
3 Path /members/id/reactivate
4 Request Method PUT
5 Required Parameters id: The MDLIVE ID assigned by MDLIVE system when the eligibility data of this patient was created.
This should be set in the path.
6 Response Status Response status will be 204 if the request is successful.
No content is returned from the server just the response status.
See Errors section for details on errors.
7 Example
   - Reactivate Member		 Request:
   PUT https://members.mdlive.com/services/members/2/reactivate
Response:
   No Content