List Patients

Endpoint: /v1/patients/list

Method: GET

Query Parameters:

Key	Value
AccountID	Required: Unique identifier for the associated clinic
pageSize	Number of Records to be returned
page	Page Number

Response

Param	Type
message	String
page	Integer
pageSize	Integer
total	Integer
data	Array[Object]
data.ID	String
data.AccountID	String
data.EmrNumber	String
data.FirstName	String
data.MiddleInitial	String
data.LastName	String
data.Suffix	String
data.DateOfBirth	String (Date)
data.Gender	String
data.MaritalStatus	String
data.SocialSecurityNumber	String
data.Ethnicity	String
data.PreferredLanguage	String
data.Allergies	Array[String]
data.MedicalConditions	Array[String]
data.Partner	Object
data.Partner.FirstName	String
data.Partner.LastName	String
data.Partner.DateOfBirth	String (Date)
data.Partner.Gender	String
data.Partner.Relationship	String
data.Partner.Contact	Object
data.Partner.Contact.Phone	String
data.Partner.Contact.Email	String
data.Contact	Object
data.Contact.Phone	String
data.Contact.MobilePhone	String
data.Contact.Email	String
data.Contact.SecondaryEmailAddress	String
data.Contact.ContactConsent	Boolean
data.Contact.EmergencyContact	Object
data.Contact.EmergencyContact.Name	String
data.Contact.EmergencyContact.Relationship	String
data.Contact.EmergencyContact.Phone	String
data.Contact.EmergencyContact.Email	String
data.Address	Object
data.Address.AddressLine1	String
data.Address.AddressLine2	String
data.Address.City	String
data.Address.State	String
data.Address.Postcode	String
data.Address.Country	String
data.Address.AddressType	String
data.Insurance	Object
data.Insurance.Provider	String
data.Insurance.PolicyNumber	String
data.Insurance.GroupNumber	String
data.IsDeleted	Boolean
data.CreatedBy	String
data.UpdatedBy	String
data.CreatedAt	String (DateTime)
data.UpdatedAt	String (DateTime)

Example

{
    "message": "Data Retrieved",
    "page": 1,
    "pageSize": 10,
    "total": 1,
    "data": [
        {
            "ID": "6758f7984546ae79067f7051",
            "AccountID": "674a51bf84090f01bec2fda7",
            "EmrNumber": "",
            "FirstName": "Eva",
            "MiddleInitial": "",
            "LastName": "Paul",
            "Suffix": "",
            "DateOfBirth": "1991-01-01",
            "Gender": "Female",
            "MaritalStatus": "Single",
            "SocialSecurityNumber": "123-45-6789",
            "Ethnicity": "Hispanic or Latino",
            "PreferredLanguage": "English",
            "Allergies": [
                "Peanuts",
                "Penicillin"
            ],
            "MedicalConditions": [
                "Diabetes",
                "Hypertension"
            ],
            "Partner": {
                "FirstName": "John",
                "LastName": "Doe",
                "DateOfBirth": "1991-01-01",
                "Gender": "Male",
                "Relationship": "Spouse",
                "Contact": {
                    "Phone": "123-456-7890",
                    "Email": "[email protected]"
                }
            },
            "Contact": {
                "Phone": "[phone]",
                "MobilePhone": "[phone]",
                "Email": "[email protected]",
                "SecondaryEmailAddress": "",
                "ContactConsent": true,
                "EmergencyContact": {
                    "Name": "John Doe",
                    "Relationship": "Father",
                    "Phone": "123-456-7890",
                    "Email": ""
                }
            },
            "Address": {
                "AddressLine1": "123 main st",
                "AddressLine2": "",
                "City": "Miami",
                "State": "Florida",
                "Postcode": "[phone]",
                "Country": "United States",
                "AddressType": "Home"
            },
            "Insurance": {
                "Provider": "Blue Cross",
                "PolicyNumber": "XYZ123456",
                "GroupNumber": "A78910"
            },
            "IsDeleted": false,
            "CreatedBy": "674a42b3f1e7347c79d309e3",
            "UpdatedBy": "674a4310f1e7347c79d309e4",
            "CreatedAt": "2024-12-11T02:23:20.635Z",
            "UpdatedAt": "2024-12-11T02:23:50.505Z"
        }
    ]
}

Error Response (400)

{
    "message": "AccountID is required"
}