Prescribers

Create single 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 — mandatory	Y
lName	String	Prescriber’s last name — mandatory	Y
username	String	Unique username — mandatory	Y
email	String	Email address — required if SMS consents are true.	Y
phone	String	Numeric, 10–15 characters. — mandatory	Y
gender	String	’M’ / ‘F’ / ‘O’. — optional	N
dateOfBirth	String	Format ‘YYYY-MM-DD’. — optional	N

Professional Details [map to details section]

Field	Type	Description	Required
details.npi	Number	10-digit NPI — mandatory	Y
details.dea	String	DEA number — conditional mandatory for controlled medications.	Y
details.speciality	String	Medical specialty — optional	N
details.providerType	String	Free-form text — optional	N

📞 Contact & Address

Mailing Address [map to mailing address]

Field	Type	Description	Required
mailingAddress.address1	String	mandatory	Y
mailingAddress.address2	String	optional	N
mailingAddress.city	String	Validated city format — mandatory	Y
mailingAddress.state	String	Valid 2-letter US state — mandatory	Y
mailingAddress.zipCode	String	5-digit numeric only — mandatory	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) — mandatory	Y
smsConsent	boolean	boolean — optional	N
dataRatesSmsConsent	boolean	boolean, defaults to true. — optional	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

POST

prescribers

create

curl --request POST \
  --url https://apidev.epiqconnect.com/prescribers/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "prescriber": {
    "fName": "John",
    "lName": "Smith",
    "username": "jsmith",
    "email": "john.doe@example.com",
    "dateOfBirth": "1990-01-01",
    "gender": "M",
    "phone": "+19998887777",
    "authSmsConsent": true,
    "smsConsent": true,
    "dataRatesSmsConsent": true,
    "details": {
      "npi": "1234567890",
      "speciality": "Endocrinology",
      "dea": "AB1234567"
    },
    "mailingAddress": {
      "address1": "465 W President George Bush Hwy",
      "address2": "Suite 240",
      "city": "Richardson",
      "state": "TX",
      "zipCode": "75080",
      "country": "US"
    },
    "ifBillingSameAsMailing": false,
    "billingAddress": {
      "address1": "789 Different Street",
      "address2": "Floor 12",
      "city": "Dallas",
      "state": "TX",
      "zipCode": "75001",
      "country": "US"
    }
  }
}
'

{
  "success": [
    {
      "index": 0,
      "UserName": "sallen",
      "FirstName": "Sherry",
      "LastName": "Allen",
      "id": "b4f88478-4071-7025-c4ea-95ca3911d3d8",
      "npi": "1467937680",
      "CreatedDate": "2025-10-14T04:17:49.231Z",
      "UpdatedDate": "2025-10-14T04:17:49.231Z",
      "clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
      "message": "Prescriber created successfully."
    },
    {
      "index": 1,
      "UserName": "samin",
      "FirstName": "Sanober",
      "LastName": "Amin",
      "id": "149884e8-c001-7037-a06f-5f04ad331ed0",
      "npi": "1477873859",
      "CreatedDate": "2025-10-14T04:17:50.412Z",
      "UpdatedDate": "2025-10-14T04:17:50.412Z",
      "clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
      "message": "Prescriber created successfully."
    }
  ],
  "errors": []
}

Headers

clinicId

string

Clinic ID for authentication

x-api-key

string

Client API key for authentication

Body

application/json

Create a single prescriber for a clinic

prescriber

object

required

Show child attributes

prescriber.clinicId

string

required

Clinic ID. Required, needs to be a valid ID

Example:

"clinic123"

prescriber.fName

string

required

Example:

"John"

prescriber.lName

string

required

Example:

"Smith"

prescriber.username

string

required

Example:

"jsmith"

prescriber.email

string

required

Example:

"john.doe@example.com"

prescriber.dateOfBirth

string

required

Example:

"1990-01-01"

prescriber.gender

string

required

Gender: M / F / O

Example:

"M"

prescriber.phone

string

required

Example:

"+19998887777"

Authorization SMS consent

Example:

true

General SMS consent flag

Example:

true

Data rates SMS consent

Example:

true

prescriber.details

object

required

Show child attributes

prescriber.details.npi

string

required

Prescriber NPI number.

Example:

"1234567890"

prescriber.details.speciality

string

required

Prescriber speciality (optional).

Example:

"Endocrinology"

prescriber.details.dea

string

required

Prescriber DEA number. Required for prescribing controlled substances.

Example:

"AB1234567"

prescriber.mailingAddress

object

required

Mailing address for the prescriber

Show child attributes

prescriber.mailingAddress.address1

string

required

First line of the address.

Example:

"465 W President George Bush Hwy"

prescriber.mailingAddress.address2

string

required

Second line of the address.

Example:

"Suite 240"

prescriber.mailingAddress.city

string

required

City.

Example:

"Richardson"

prescriber.mailingAddress.state

string

required

State.

Example:

"TX"

prescriber.mailingAddress.zipCode

string

required

Zip code.

Example:

"75080"

prescriber.mailingAddress.country

string

required

Country.

Example:

"US"

prescriber.ifBillingSameAsMailing

boolean

required

Whether billing address is same as mailing address

Example:

true

prescriber.billingAddress

object

Billing address (required if different from mailing)

Show child attributes

prescriber.billingAddress.address1

string

required

First line of the address.

Example:

"465 W President George Bush Hwy"

prescriber.billingAddress.address2

string

required

Second line of the address.

Example:

"Suite 240"

prescriber.billingAddress.city

string

required

City.

Example:

"Richardson"

prescriber.billingAddress.state

string

required

State.

Example:

"TX"

prescriber.billingAddress.zipCode

string

required

Zip code.

Example:

"75080"

prescriber.billingAddress.country

string

required

Country.

Example:

"US"

Response

Prescribers Creation Success

Get prescribers by clinic ID ***⚕️ Get Prescribers by Clinic — Field Reference*** This endpoint fetches the list of prescribers associated with a specific clinic. The returned structure follows ***PrescriberDetailsDto*** and related internal models. --- ### 🛡️ Security #### **Headers** | **Field** | **Description** | |:--------|:-------------| | **x-api-key** | API Key required for authentication. | | **clinicId** | Clinic ID in header overrides route parameter (optional).| #### **Route Parameter** | **Param** | **Description** | |:--------|:-------------| | **clinicId** | Unique clinic identifier to fetch prescribers for — **mandatory**. | --- ### 📋 What This Endpoint Returns This API returns **all prescribers assigned to the given clinic**, including: - Prescriber demographics (name, gender, DOB) - Contact details - Professional identifiers (NPI, DEA, specialty) - Address information - Consent flags - Associated metadata --- ### 🎯 Successful Response Structure **Prescriber Identity** | **Field** | **Description** | |:--------|:-------------| | **fName** | First name of prescriber. | | **lName** | Last name of prescriber. | | **username** | Unique username. | | **gender** | 'M', 'F', 'O'. | | **dateOfBirth** | Format: 'YYYY-MM-DD'. | #### **Professional Details** | **Field** | **Description** | |:--------|:-------------| | **npi** | National Provider Identifier. | | **dea** | DEA number. | | **speciality** | Medical specialty (optional). | | **providerType** | Optional provider classification. | --- ### 🏠 Address & Contact #### **Mailing / Billing Address** | Field | Description | |--------|-------------| | **address1** | Primary address line. | | **address2** | Optional second line. | | **city** | Valid US city. | | **state** | Two-letter US state code. | | **zipCode** | 5-digit numeric zip. | | **country** | Defaults to 'US'. | #### **Contact Info** | Field | Description | |--------|-------------| | **email** | Optional; required if SMS consent true. | | **phone** | Mandatory; validated phone number. | | **authSmsConsent** | Mandatory boolean. | | **smsConsent** | Optional boolean. | | **dataRatesSmsConsent** | Optional boolean (default 'true'). | --- ### ⚠️ Important Notes | Notice | Details | |--------|---------| | **Validation** | All fields returned were previously validated during creation. | | **Permissions** | API key must be authorized for the requested clinic. | | **Errors** | 404 returned if clinic has no prescribers or does not exist. | ---

⌘I

curl --request POST \
  --url https://apidev.epiqconnect.com/prescribers/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "prescriber": {
    "fName": "John",
    "lName": "Smith",
    "username": "jsmith",
    "email": "john.doe@example.com",
    "dateOfBirth": "1990-01-01",
    "gender": "M",
    "phone": "+19998887777",
    "authSmsConsent": true,
    "smsConsent": true,
    "dataRatesSmsConsent": true,
    "details": {
      "npi": "1234567890",
      "speciality": "Endocrinology",
      "dea": "AB1234567"
    },
    "mailingAddress": {
      "address1": "465 W President George Bush Hwy",
      "address2": "Suite 240",
      "city": "Richardson",
      "state": "TX",
      "zipCode": "75080",
      "country": "US"
    },
    "ifBillingSameAsMailing": false,
    "billingAddress": {
      "address1": "789 Different Street",
      "address2": "Floor 12",
      "city": "Dallas",
      "state": "TX",
      "zipCode": "75001",
      "country": "US"
    }
  }
}
'

{
  "success": [
    {
      "index": 0,
      "UserName": "sallen",
      "FirstName": "Sherry",
      "LastName": "Allen",
      "id": "b4f88478-4071-7025-c4ea-95ca3911d3d8",
      "npi": "1467937680",
      "CreatedDate": "2025-10-14T04:17:49.231Z",
      "UpdatedDate": "2025-10-14T04:17:49.231Z",
      "clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
      "message": "Prescriber created successfully."
    },
    {
      "index": 1,
      "UserName": "samin",
      "FirstName": "Sanober",
      "LastName": "Amin",
      "id": "149884e8-c001-7037-a06f-5f04ad331ed0",
      "npi": "1477873859",
      "CreatedDate": "2025-10-14T04:17:50.412Z",
      "UpdatedDate": "2025-10-14T04:17:50.412Z",
      "clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
      "message": "Prescriber created successfully."
    }
  ],
  "errors": []
}

Overview

Patients

Prescribers

Prescriptions

Create single prescriber for single clinic

🛡️ Security

Headers

🩺 Prescriber Identity & Basic Info

Basic Details [ map at prescriber level]

Professional Details [map to details section]

📞 Contact & Address

Mailing Address [map to mailing address]

Billing Address [map to billing address]

✍️ Consents

Communication Consents [used for communication with prescriber for login to ‘EpiqConnect’, values need to be present , set to false if not applicable]

⚠️ Notes & Limits

⛔Possible Errors

Headers

Body

Response