Search Patient - EpiqScripts

GET

/

patients

/

search

Search Patient

curl --request GET \
  --url https://apidev.epiqconnect.com/patients/search \
  --header 'apiKey: <apikey>' \
  --header 'clinicId: <clinicid>'

Headers

clinicId

string

required

Clinic secret for authentication

apiKey

string

required

Client API key for authentication

Query Parameters

email

string

Patient email address

phoneNumber

string

Patient phone number (digits only or +1 prefix)

Response

200 - application/json

Patient record retrieved successfully.

Create Prescriber For Single Clinic ***⚕️ Prescriber Creation — Field Reference*** This endpoint creates new prescriber records for a single clinic. All validations follow **CreatePrescriberDto** constraints. --- ### 🛡️ Security #### **Headers** | **Field** | **Type** | **Description** | **Required** | |--------|-------------|-------------|-------------| | **x-api-key** |**String** |**API Key for authentication** |**Y** | | **clinicId** | **String** |**Clinic ID in header overrides route parameter**| **Y** | --- ### **🩺** Prescriber Identity & Basic Info #### **Basic Details** [ map at prescriber level] | **Field** | **Type** | **Description** | **Required**| |--------|-------------|-------------|-------------| | **fName** | **String** |**Prescriber's first name** -- <Badge color="green">**mandatory**</Badge> | **Y** | | **lName** | **String** |**Prescriber's last name** -- <Badge color="green">**mandatory**</Badge> | **Y** | | **username** | **String** |**Unique username** -- <Badge color="green">**mandatory**</Badge> | **Y** | | **email** | **String** |**Email address** — required if SMS consents are true. | **Y** | | **phone** | **String** | Numeric, 10–15 characters. -- <Badge color="green">**mandatory**</Badge> | **Y** | | **gender** | **String** | 'M' / 'F' / 'O'. -- <Badge color="gray">**optional**</Badge> | **N** | | **dateOfBirth** | **String** | Format 'YYYY-MM-DD'. -- <Badge color="gray">**optional**</Badge> | **N** | #### Professional Details [map to details section] | **Field** | **Type** | **Description** | **Required**| |--------|-------------|-------------|-------------| | **details.npi** |**Number**| **10-digit NPI** -- <Badge color="green">**mandatory**</Badge> | **Y** | | **details.dea** | **String**|DEA number -- <Badge color="orange">**conditional mandatory**</Badge> for controlled medications. | **Y** | | **details.speciality** |**String** | Medical specialty -- <Badge color="gray">**optional**</Badge>| **N**| | **details.providerType** | **String**| Free-form text -- <Badge color="gray">**optional**</Badge> | **N** | --- ### 📞 Contact & Address #### **Mailing Address** [map to mailing address] | **Field** | **Type** | **Description** | **Required**| |--------|-------------|-------------|-------------| | **mailingAddress.address1** |**String** |<Badge color="green">**mandatory**</Badge> |**Y** | | **mailingAddress.address2** | **String**|<Badge color="gray">**optional**</Badge> |**N** | | **mailingAddress.city** |**String** | Validated city format -- <Badge color="green">**mandatory**</Badge> |**Y** | | **mailingAddress.state** |**String** | Valid 2-letter US state -- <Badge color="green">**mandatory**</Badge> | **Y**| | **mailingAddress.zipCode** |**String** | 5-digit numeric only -- <Badge color="green">**mandatory**</Badge> |**Y** | | **mailingAddress.country** | **String**|Defaults to 'US'. |**Y** | #### **Billing Address** [map to billing address] | **Field** | **Type** | **Description** | **Required**| |--------|-------------|-------------|-------------| | **ifBillingSameAsMailing** |**boolean** | **'true/false'** ,if true, billing uses mailing address. | **Y**| | **billingAddress** |**Address Object** |Required only if *not* same as mailing. Billing Address object is optional only if **'ifBillingSameAsMailing'** is set to **true** |**Y/N** | --- ### ✍️ Consents #### **Communication Consents** [used for communication with prescriber for login to **'EpiqConnect'**, values need to be present , set to false if not applicable] | **Field** | **Type** | **Description** | **Required**| |--------|-------------|-------------|-------------| | **authSmsConsent** |**boolean** | boolean (true/false) -- <Badge color="green">**mandatory**</Badge> | **Y**| | **smsConsent** |**boolean** |boolean -- <Badge color="gray">**optional**</Badge> | **N**| | **dataRatesSmsConsent** |**boolean**| boolean, defaults to true. -- <Badge color="gray">**optional**</Badge> |**N** | --- ### ⚠️ Notes & Limits | Notice | Details | |--------|---------| | **Validation** | Field-level validation applied before processing. | | **Errors** | Returns 401 for invalid API key/clinicId; 400 for invalid payload. | | **Bulk restriction** | This endpoint handles **1 prescriber only**. | --- ### ⛔Possible Errors | Status Code | Error | Description | Solution | |--------|---------|----------------|----------| |401| Authentication failed| Invalid API key or clinicId combination| Correct combination of ClinicId and API key to be provided| |400| Validation failed| First name is required and can only contain letters (A-Z, a-z). No spaces, hyphens, apostrophes, numbers, special, binary, or SQL injection characters allowed. | First name cannot be empty. Provide name satisfying the conditions| |400| Validation failed| Last name is required and can only contain letters (A-Z, a-z). No spaces, hyphens, apostrophes, numbers, special, binary, or SQL injection characters allowed.| Last Name cannot be empty. Provide name satisfying the conditions| |400| Validation failed| Date of Birth is required, must be in YYYY-MM-DD format, year must be after 1900, and age must be 18 or older| DOB should be in proper format| |400| Validation failed| gender must be one of M(male), F (female), O (other/unknown) |Provide proper Gender| |400| Validation failed| email must be a valid email address and only contain letters, numbers, @, and . (no multiple consecutive dots or more than one @ symbol) || |400| Validation failed| phone must be 10 digits, optionally prefixed by +1, and contain only numbers|| |400| Validation failed| NPI Registry validation failed: Invalid NPI type. Only individual NPIs (Type 1) are allowed. |Valid NPI needs to be provided | |400| Validation failed| Failed to update prescriber/user/address: Failed to update user, please try again later | User Name should be unique and match with Prescriber NPI| |400| Validation failed| Prescriber already exists but could not find user for update. |UserName and PrescriberNPI does not match.| |400| Validation failed| address.address1 is required, must not contain 'P.O Box', 'POBox', or 'Post Office Box', cannot have special, binary, or SQL injection characters, and must not contain script injection| | |400| Validation failed| address.zipCode must be exactly 5 digits or 9 digits in format 12345-1234||

⌘I

Search Patient

curl --request GET \
  --url https://apidev.epiqconnect.com/patients/search \
  --header 'apiKey: <apikey>' \
  --header 'clinicId: <clinicid>'