DoseSpot REST API

https://my.staging.dosespot.com/webapi/v2/
Admin
DoseSpot REST API is a comprehensive healthcare API that provides endpoints for managing patient...
Tokens:72,136
Snippets:215
Trust Score:9.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /api/general/check

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Verifies that the API is operational and running.

```APIDOC
## GET /api/general/check

### Description
Verifies the API is up and running.

### Method
GET

### Endpoint
/api/general/check

### Response
#### Success Response (200)
- **schema** (object) - The schema for the general response.

#### Response Example
{
  "example": "Response"
}
```

--------------------------------

### GET /api/supplies/search

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Search supplies matching the exact NDC or exact UPC.

```APIDOC
## GET /api/supplies/search

### Description
Search supplies matching the exact NDC or exact UPC.

### Method
GET

### Endpoint
/api/supplies/search

### Parameters
#### Query Parameters
- **NDC** (string) - Optional - Exact National Drug Code
- **UPC** (string) - Optional - Exact Universal Product Code

### Response
#### Success Response (200)
- **supplies** (array) - List of matching supplies

#### Response Example
```json
{
  "example": "Search supplies response body"
}
```
```

--------------------------------

### GET /api/medications/searchByRxCUI

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Returns a list of drugs based on an rxCUI.

```APIDOC
## GET /api/medications/searchByRxCUI

### Description
Returns a list of drugs based on an rxCUI.

### Method
GET

### Endpoint
/api/medications/searchByRxCUI

#### Query Parameters
- **rxCUI** (string) - Optional - rxCUI

### Response
#### Success Response (200)
- **ListResponse[MedicationSelectResult]** - OK
```

--------------------------------

### Get Order Sets

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a paginated list of order sets, with options for sorting and searching.

```APIDOC
## GET /api/v2/orderSets

### Description
Retrieves a paginated list of order sets. Allows for sorting by 'Asc' or 'Desc' and searching by a specified string.

### Method
GET

### Endpoint
/api/v2/orderSets

### Query Parameters
- **SortOrder** (string) - Optional - Specifies the sort order for the results. Accepted values are 'Asc' or 'Desc'. Defaults to 'Asc'.
- **SearchString** (string) - Optional - A string to filter order sets by.

### Response
#### Success Response (200)
- **Items** (array) - An array of OrderSetResponse objects.
- **PageResult** (object) - Contains pagination information.
- **Result** (object) - Contains the result of the operation.
```

--------------------------------

### GET /api/priorAuths/{priorAuthId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves detailed information for a single prior authorization case by its ID.

```APIDOC
## GET /api/priorAuths/{priorAuthId}

### Description
Retrieves Details For A Single Prior Authorization Case

### Method
GET

### Endpoint
/api/priorAuths/{priorAuthId}

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - Prior Authorization Case ID

### Response
#### Success Response (200)
- **caseDetails** (object) - Detailed information about the prior authorization case.

#### Response Example
```json
{
  "caseDetails": {
    "caseId": 123,
    "patientName": "John Doe",
    "status": "Approved",
    "creationDate": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### GET /api/priorAuths/{priorAuthId}/questions/{questionId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves the details of a single prior authorization question.

```APIDOC
## GET /api/priorAuths/{priorAuthId}/questions/{questionId}

### Description
Gets the details of a single prior authorization question.

### Method
GET

### Endpoint
/api/priorAuths/{priorAuthId}/questions/{questionId}

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - Prior Authorization Case ID
- **questionId** (integer) - Required - Prior Authorization Question ID

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body"
}
```

### Response
#### Success Response (200)
- **object** (object) - Details of the prior authorization question.

#### Response Example
```json
{
  "example": "Question details object"
}
```
```

--------------------------------

### GET /api/patients/{patientId}/prescriptions/{prescriptionId}/snapshot

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a snapshot of a specific prescription.

```APIDOC
## GET /api/patients/{patientId}/prescriptions/{prescriptionId}/snapshot

### Description
Retrieves prescription snapshot.

### Method
GET

### Endpoint
/api/patients/{patientId}/prescriptions/{prescriptionId}/snapshot

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - Patient ID
- **prescriptionId** (integer) - Required - Prescription ID

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **schema** (object) - Reference to PrescriptionSnapshotResponse definition

#### Response Example
```json
{
  "example": "PrescriptionSnapshotResponse object"
}
```
```

--------------------------------

### GET /api/priorAuths/{priorAuthId}/statusLog

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves the status log for a specific prior authorization case.

```APIDOC
## GET /api/priorAuths/{priorAuthId}/statusLog

### Description
Retrieves the status log for a specific prior authorization case.

### Method
GET

### Endpoint
/api/priorAuths/{priorAuthId}/statusLog

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - Prior Authorization Case ID

### Response
#### Success Response (200)
- **PriorAuthorizationStatusLogUIResponse** (object) - The response object containing the status log.
```

--------------------------------

### GET /api/pharmacies/search

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Returns a list of pharmacies matching the specified search parameters.

```APIDOC
## GET /api/pharmacies/search

### Description
Returns a list of pharmacies matching the specified search parameters.

### Method
GET

### Endpoint
/api/pharmacies/search

### Parameters
#### Query Parameters
- **[Search Parameters]** - The specific parameters for searching pharmacies (e.g., name, zip code, etc.). Details depend on implementation.

### Response
#### Success Response (200)
- **[Pharmacy List]** - A list of pharmacy objects matching the search criteria.

#### Response Example
{
  "example": "{\"pharmacies\": [{\"name\": \"Example Pharmacy\", \"address\": \"123 Main St\"}, ...] }"
}
```

--------------------------------

### Get Supply By ID

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves detailed information for a specific supply using its unique ID.

```APIDOC
## GET /api/supplies/{supplyId}

### Description
Returns a supply matching the ID.

### Method
GET

### Endpoint
/api/supplies/{supplyId}

### Parameters
#### Path Parameters
- **supplyId** (integer) - Required - The ID of the supply to retrieve.

### Response
#### Success Response (200)
- **Item** (object) - The supply search result details.
- **Result** (object) - The result of the operation.
```

--------------------------------

### GET /api/priorAuths/{priorAuthId}/questions/{questionId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves details for a specific question within a prior authorization.

```APIDOC
## GET /api/priorAuths/{priorAuthId}/questions/{questionId}

### Description
Retrieves details for a specific question within a prior authorization.

### Method
GET

### Endpoint
/api/priorAuths/{priorAuthId}/questions/{questionId}

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - Prior Authorization ID
- **questionId** (integer) - Required - Question ID

### Response
#### Success Response (200)
- **PriorAuthQuestionResponse** (object) - The response object containing question details.
```

--------------------------------

### GET /api/dispenseUnits

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Returns a detailed list of all available dispense unit types for prescription requests.

```APIDOC
## GET /api/dispenseUnits

### Description
Returns a detailed list of all types of dispense units available for prescription requests.

### Method
GET

### Endpoint
/api/dispenseUnits

### Response
#### Success Response (200)
- **schema** (object) - Reference to the ListResponse[StandardDispenseUnitType] definition.
```

--------------------------------

### GET /api/priorAuths/{priorAuthId}/attachments/{attachmentId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Downloads a specific attachment associated with a prior authorization case.

```APIDOC
## GET /api/priorAuths/{priorAuthId}/attachments/{attachmentId}

### Description
Downloads an attachment as a file.

### Method
GET

### Endpoint
/api/priorAuths/{priorAuthId}/attachments/{attachmentId}

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - priorAuthCaseId
- **attachmentId** (integer) - Required - Attachment ID

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body"
}
```

### Response
#### Success Response (200)
- **object** (object) - The attachment file content.

#### Response Example
```json
{
  "example": "File content"
}
```
```

--------------------------------

### GET /api/clinic/ordersets

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a paginated list of clinic Order Sets with optional sorting and filtering.

```APIDOC
## GET /api/clinic/ordersets

### Description
Retrieves a paginated list of clinic Order Sets with optional sorting and filtering.

### Method
GET

### Endpoint
/api/clinic/ordersets

### Parameters
#### Query Parameters
- **pageNumber** (integer) - Optional - Gets or sets the page number for the request. Default value will be 1.
- **pageSize** (integer) - Optional - Gets or sets the page size for the request. Default value will be 20.
- **sortOrder** (string) - Optional - Gets or sets the sort order for the request. Value will be Asc or Desc. Default value will be Asc. (Enum: Asc, Desc)
- **searchString** (string) - Optional - Gets or sets the search string for the request.

### Response
#### Success Response (200)
- **items** (array) - An array of ClinicOrderSetResponse objects.
- **totalCount** (integer) - The total number of order sets available.

#### Response Example
```json
{
  "items": [
    {
      "id": 1,
      "name": "Order Set A",
      "description": "Description for Order Set A"
    }
  ],
  "totalCount": 10
}
```
```

--------------------------------

### POST /api/clinicians/{clinicianId}/idpInit

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Marks the clinician IDP as initialized. This is a prerequisite for starting the identity proofing process.

```APIDOC
## POST /api/clinicians/{clinicianId}/idpInit

### Description
Mark Clinician IDP Initialized.

### Method
POST

### Endpoint
/api/clinicians/{clinicianId}/idpInit

#### Path Parameters
- **clinicianId** (integer) - Required - Clinician ID

### Response
#### Success Response (200)
- **schema** (object) - OK (schema: #/definitions/Response)
```

--------------------------------

### POST /api/priorAuths/initiate

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Initiates a prior authorization request for a patient's prescription.

```APIDOC
## POST /api/priorAuths/initiate

### Description
Initiates prior authorization for a patients prescription.

### Method
POST

### Endpoint
/api/priorAuths/initiate

### Parameters
#### Request Body
- **request** (PriorAuthInitiationRequest) - Required - The request body containing details for initiating the prior authorization.

### Response
#### Success Response (200)
- **identifier** (string) - The identifier of the newly initiated prior authorization case.

#### Response Example
```json
{
  "identifier": "new_pa_case_id"
}
```
```

--------------------------------

### POST /websites/my_staging_dosespot_webapi_v2/FreeTextSupplyPrescription

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Creates a free text supply prescription. This endpoint is used for prescriptions that are not tied to a specific coded drug.

```APIDOC
## POST /websites/my_staging_dosespot_webapi_v2/FreeTextSupplyPrescription

### Description
Creates a free text supply prescription. This endpoint is used for prescriptions that are not tied to a specific coded drug.

### Method
POST

### Endpoint
/websites/my_staging_dosespot_webapi_v2/FreeTextSupplyPrescription

### Parameters
#### Request Body
- **FreeTextSupplyPrescriptionRequest** (object) - Required - Represents the details of the free text supply prescription.
  - **DisplayName** (string) - Required - The display name of the medication (3-300 characters).
  - **NotControlled** (boolean) - Required - Indicates if the medication is not a controlled substance.
  - **Refills** (integer) - Required - The number of refills allowed (0-99).
  - **DaysSupply** (integer) - Optional - The number of days the supply is intended for (0-365).
  - **DispenseUnitId** (integer) - Required - The ID of the dispense unit.
  - **Quantity** (number) - Required - The quantity of the medication to dispense.
  - **Directions** (string) - Required - The directions for taking the medication (max 1000 characters).
  - **PharmacyId** (integer) - Optional - The ID of the pharmacy.
  - **PharmacyNotes** (string) - Optional - Notes for the pharmacy (max 210 characters).
  - **NoSubstitutions** (boolean) - Optional - Indicates if substitutions are not allowed.
  - **EffectiveDate** (string) - Optional - The effective date of the prescription (ISO 8601 format).
  - **RxReferenceNumber** (string) - Optional - A reference number for the prescription (max 35 characters).
  - **EligibilityId** (integer) - Optional - The ID for eligibility.
  - **NonDoseSpotPrescriptionId** (string) - Optional - A non-DoseSpot prescription ID (max 35 characters).
  - **FirstPrescriptionDiagnosis** (object) - Optional - Details of the first prescription diagnosis.
  - **SecondPrescriptionDiagnosis** (object) - Optional - Details of the second prescription diagnosis.
  - **IsRefillReplace** (boolean) - Optional - Indicates if this is a refill replacement.
  - **IsUrgent** (boolean) - Optional - Indicates if the prescription is urgent.
  - **SupervisorId** (integer) - Optional - The ID of the supervisor.
  - **RetailPharmacyToMailToPatient** (boolean) - Optional - Indicates if retail pharmacy should mail to patient.
  - **RTPSCoupon** (object) - Optional - Coupon details for RTPS.
    - **BIN** (string) - Optional - BIN number.
    - **PCN** (string) - Optional - PCN number.
    - **MemberID** (string) - Optional - Member ID.
    - **GroupID** (string) - Optional - Group ID.
  - **Status** (string) - Required - The status of the prescription (e.g., 'Active', 'Inactive'). Enum: ["Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill"]
  - **InactiveDate** (string) - Optional - The date the prescription becomes inactive (ISO 8601 format).
  - **Comment** (string) - Optional - A comment for the prescription (max 500 characters).
  - **Encounter** (string) - Optional - Encounter details (max 50 characters).

### Request Example
```json
{
  "DisplayName": "Amoxicillin 500mg",
  "NotControlled": true,
  "Refills": 2,
  "DispenseUnitId": 1,
  "Quantity": 20.0,
  "Directions": "Take one capsule every 8 hours for 10 days.",
  "Status": "Active"
}
```

### Response
#### Success Response (200)
- **PrescriptionId** (integer) - The ID of the created prescription.
- **Message** (string) - A success message.

#### Response Example
```json
{
  "PrescriptionId": 98766,
  "Message": "Free text supply prescription created successfully."
}
```
```

--------------------------------

### GET /api/patients/{patientId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves the demographic information for a specific patient.

```APIDOC
## GET /api/patients/{patientId}

### Description
Retrieves the existing demographic information in a patient record.

### Method
GET

### Endpoint
/api/patients/{patientId}

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - Patient ID

### Response
#### Success Response (200)
- **ItemResponse[GetPatient]** - An object containing the patient's demographic data.

#### Response Example
{
  "example": "{\"item\": {\"firstName\": \"John\", \"lastName\": \"Doe\", ...}}"
}
```

--------------------------------

### GET /api/medications/select

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Selects a drug based on rxCUI OR NDC OR DispensableDrugId.

```APIDOC
## GET /api/medications/select

### Description
Selects a drug based on rxCUI OR NDC OR DispensableDrugId.

### Method
GET

### Endpoint
/api/medications/select

#### Query Parameters
- **dispensableDrugId** (integer) - Optional
- **nDC** (string) - Optional
- **rXCUI** (string) - Optional

### Response
#### Success Response (200)
- **[Response Schema]** - OK
```

--------------------------------

### POST /api/patients/{patientId}/prescriptions/readyToSign

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Sets one or more prescriptions for a patient as 'Ready to Sign'. This is a crucial step before a prescription can be finalized or sent.

```APIDOC
## POST /api/patients/{patientId}/prescriptions/readyToSign

### Description
Set 1 or more prescriptions as Ready to Sign for a specific patient.

### Method
POST

### Endpoint
/api/patients/{patientId}/prescriptions/readyToSign

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - Patient ID

#### Query Parameters
None

#### Request Body
- **request** (object) - Required - Contains the list of prescription IDs and DEA Overrides.
  - **prescriptionIds** (array[integer]) - Required - A list of prescription IDs to set as ready to sign.
  - **deaOverrides** (object) - Optional - DEA override information if applicable.
    - **overrideType** (string) - Required - The type of DEA override.
    - **overrideValue** (string) - Required - The value of the DEA override.

### Request Example
```json
{
  "prescriptionIds": [123, 456],
  "deaOverrides": {
    "overrideType": "DEA_SCHEDULE_IV",
    "overrideValue": "XYZ1234567"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **message** (string) - A message describing the result of the operation.

#### Response Example
```json
{
  "status": "Success",
  "message": "Prescriptions updated successfully."
}
```
```

--------------------------------

### POST /websites/my_staging_dosespot_webapi_v2/CodedSupply

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Creates a coded supply prescription. This endpoint is used for prescriptions where the supply is coded.

```APIDOC
## POST /websites/my_staging_dosespot_webapi_v2/CodedSupply

### Description
Creates a coded supply prescription. This endpoint is used for prescriptions where the supply is coded.

### Method
POST

### Endpoint
/websites/my_staging_dosespot_webapi_v2/CodedSupply

### Parameters
#### Request Body
- **CodedSupplyRequest** (object) - Required - Represents the details of the coded supply prescription.
  - **SupplyId** (integer) - Required - The ID of the supply (1-2147483647).
  - **Refills** (integer) - Required - The number of refills allowed (0-99).
  - **DaysSupply** (integer) - Optional - The number of days the supply is intended for (0-365).
  - **DispenseUnitId** (integer) - Required - The ID of the dispense unit.
  - **Quantity** (number) - Required - The quantity of the medication to dispense.
  - **Directions** (string) - Required - The directions for taking the medication (max 1000 characters).
  - **PharmacyId** (integer) - Optional - The ID of the pharmacy.
  - **PharmacyNotes** (string) - Optional - Notes for the pharmacy (max 210 characters).
  - **NoSubstitutions** (boolean) - Optional - Indicates if substitutions are not allowed.
  - **EffectiveDate** (string) - Optional - The effective date of the prescription (ISO 8601 format).
  - **RxReferenceNumber** (string) - Optional - A reference number for the prescription (max 35 characters).
  - **EligibilityId** (integer) - Optional - The ID for eligibility.
  - **NonDoseSpotPrescriptionId** (string) - Optional - A non-DoseSpot prescription ID (max 35 characters).
  - **FirstPrescriptionDiagnosis** (object) - Optional - Details of the first prescription diagnosis.
  - **SecondPrescriptionDiagnosis** (object) - Optional - Details of the second prescription diagnosis.
  - **IsRefillReplace** (boolean) - Optional - Indicates if this is a refill replacement.
  - **IsUrgent** (boolean) - Optional - Indicates if the prescription is urgent.
  - **SupervisorId** (integer) - Optional - The ID of the supervisor.
  - **RetailPharmacyToMailToPatient** (boolean) - Optional - Indicates if retail pharmacy should mail to patient.
  - **RTPSCoupon** (object) - Optional - Coupon details for RTPS.
    - **BIN** (string) - Optional - BIN number.
    - **PCN** (string) - Optional - PCN number.
    - **MemberID** (string) - Optional - Member ID.
    - **GroupID** (string) - Optional - Group ID.
  - **Status** (string) - Required - The status of the prescription (e.g., 'Active', 'Inactive'). Enum: ["Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill"]
  - **InactiveDate** (string) - Optional - The date the prescription becomes inactive (ISO 8601 format).
  - **Comment** (string) - Optional - A comment for the prescription (max 500 characters).
  - **Encounter** (string) - Optional - Encounter details (max 50 characters).

### Request Example
```json
{
  "SupplyId": 101,
  "Refills": 1,
  "DispenseUnitId": 2,
  "Quantity": 1.0,
  "Directions": "Apply topically as directed.",
  "Status": "Active"
}
```

### Response
#### Success Response (200)
- **PrescriptionId** (integer) - The ID of the created prescription.
- **Message** (string) - A success message.

#### Response Example
```json
{
  "PrescriptionId": 98767,
  "Message": "Coded supply prescription created successfully."
}
```
```

--------------------------------

### POST /api/priorAuths/{priorAuthId}/submit

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Submits the answers for a prior authorization case, initiating the next steps.

```APIDOC
## POST /api/priorAuths/{priorAuthId}/submit

### Description
Submits answers of a prior authorization case, which will send the answers out.

### Method
POST

### Endpoint
/api/priorAuths/{priorAuthId}/submit

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - PriorAuth Case ID

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body"
}
```

### Response
#### Success Response (200)
- **IdentifierResponse** (object) - Response containing an identifier related to the submission.

#### Response Example
```json
{
  "example": "IdentifierResponse object"
}
```
```

--------------------------------

### GET /api/clinician

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves clinician information based on NPI or DEA number.

```APIDOC
## GET /api/clinician

### Description
Get Clinician By Npi Or Dea.

### Method
GET

### Endpoint
/api/clinician

### Parameters
#### Query Parameters
- **npi** (string) - Optional - NPI number
- **dea** (string) - Optional - DEA number

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **IdentifierResponse** (object) - OK (schema: #/definitions/IdentifierResponse)

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### POST /websites/my_staging_dosespot_webapi_v2/Patient

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Adds a new patient to the system. Requires a detailed patient object in the request body.

```APIDOC
## POST /websites/my_staging_dosespot_webapi_v2/Patient

### Description
Adds a new patient to the system. Requires a detailed patient object in the request body.

### Method
POST

### Endpoint
/websites/my_staging_dosespot_webapi_v2/Patient

### Parameters
#### Request Body
- **AddEditPatientRequest** (object) - Required - Contains the details of the patient to be added.
  - **FirstName** (string) - Required - The first name of the patient.
  - **LastName** (string) - Required - The last name of the patient.
  - **DateOfBirth** (string) - Required - The date of birth of the patient (ISO 8601 format).
  - **Gender** (string) - Required - The gender of the patient (Male, Female, Unknown).
  - **Address1** (string) - Required - The primary address line.
  - **City** (string) - Required - The city of the address.
  - **State** (string) - Required - The state of the address.
  - **ZipCode** (string) - Required - The zip code of the address.
  - **PrimaryPhone** (string) - Required - The primary phone number.
  - **PrimaryPhoneType** (string) - Required - The type of the primary phone number.
  - **Active** (boolean) - Required - Indicates if the patient record is active.
  - **Prefix** (string) - Optional - The prefix for the patient's name.
  - **MiddleName** (string) - Optional - The middle name of the patient.
  - **Suffix** (string) - Optional - The suffix for the patient's name.
  - **Email** (string) - Optional - The email address of the patient.
  - **Address2** (string) - Optional - The secondary address line.
  - **PhoneAdditional1** (string) - Optional - An additional phone number.
  - **PhoneAdditional2** (string) - Optional - Another additional phone number.
  - **PhoneAdditionalType1** (string) - Optional - The type of the first additional phone number.
  - **PhoneAdditionalType2** (string) - Optional - The type of the second additional phone number.
  - **Weight** (number) - Optional - The weight of the patient.
  - **WeightMetric** (string) - Optional - The unit of weight (lb, kg).
  - **Height** (number) - Optional - The height of the patient.
  - **HeightMetric** (string) - Optional - The unit of height (inch, cm).
  - **NonDoseSpotMedicalRecordNumber** (string) - Optional - A medical record number from a non-DoseSpot system.
  - **Encounter** (string) - Optional - Information about the patient's encounter.
  - **IsHospice** (boolean) - Optional - Indicates if the patient is in hospice care.

### Request Example
```json
{
  "FirstName": "Jane",
  "LastName": "Smith",
  "DateOfBirth": "1995-05-15T00:00:00",
  "Gender": "Female",
  "Address1": "456 Oak Ave",
  "City": "Otherville",
  "State": "NY",
  "ZipCode": "10001",
  "PrimaryPhone": "555-987-6543",
  "PrimaryPhoneType": "Cell",
  "Active": true
}
```

### Response
#### Success Response (200)
- **Result** (object) - Contains the result of the operation, typically indicating success or failure.

#### Response Example
```json
{
  "Result": {
    "Success": true,
    "Message": "Patient added successfully."
  }
}
```
```

--------------------------------

### POST /api/clinicians/{clinicianId}/initTfaActivate

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Initializes the activation of a clinician's two-factor authentication.

```APIDOC
## POST /api/clinicians/{clinicianId}/initTfaActivate

### Description
Initializes activation of a clinician's two factor authentication. This endpoint starts the process for enabling two-factor authentication for a specific clinician.

### Method
POST

### Endpoint
/api/clinicians/{clinicianId}/initTfaActivate

### Parameters
#### Path Parameters
- **clinicianId** (integer) - Required - The unique identifier for the clinician.

#### Request Body
- **request** (ClinicianInitializeTfaActivationRequest) - Required - The request object containing data for initializing TFA activation.

### Request Example
```json
{
  "example": "ClinicianInitializeTfaActivationRequest object"
}
```

### Response
#### Success Response (200)
- **Response** - A response object indicating the success or failure of the initialization.

#### Response Example
```json
{
  "example": "Response object"
}
```
```

--------------------------------

### GET /api/patients/{patientId}/selfReportedMedications

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves details of self-reported medications in a patient record.

```APIDOC
## GET /api/patients/{patientId}/selfReportedMedications

### Description
Retrieves details of self-reported medications in a patient record.

### Method
GET

### Endpoint
/api/patients/{patientId}/selfReportedMedications

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - Patient ID

#### Query Parameters
- **startDate** (string) - Optional - Start date for filtering (date-time format)
- **endDate** (string) - Optional - End date for filtering (date-time format)
- **pageNumber** (integer) - Optional - Page number for pagination

### Response
#### Success Response (200)
- **items** (array) - List of self-reported medication responses
- **pageCount** (integer) - Total number of pages
- **totalItems** (integer) - Total number of items

#### Response Example
```json
{
  "example": "PagedListResponse[SelfReportedMedicationResponse] body"
}
```
```

--------------------------------

### GET /api/refills/pending

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves information on pending refill requests associated with a clinic or patient.

```APIDOC
## GET /api/refills/pending

### Description
Retrieves information on pending refill requests associated with a clinic or patient.

### Method
GET

### Endpoint
/api/refills/pending

### Parameters
#### Query Parameters
- **clinic** (string) - Optional - Filters by clinic. Allowed values: "All", "Current".
- **patientId** (string) - Optional - Filters by patient ID.
```

--------------------------------

### POST /websites/my_staging_dosespot_webapi_v2/CodedPrescription

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Creates a coded prescription. This endpoint allows for the creation of prescriptions using predefined drug codes.

```APIDOC
## POST /websites/my_staging_dosespot_webapi_v2/CodedPrescription

### Description
Creates a coded prescription. This endpoint allows for the creation of prescriptions using predefined drug codes.

### Method
POST

### Endpoint
/websites/my_staging_dosespot_webapi_v2/CodedPrescription

### Parameters
#### Request Body
- **CodedPrescriptionRequest** (object) - Required - Represents the details of the coded prescription.
  - **DispensableDrugId** (integer) - Required - The ID of the dispensable drug.
  - **PatientFormularyId** (integer) - Optional - The ID of the patient's formulary.
  - **Refills** (integer) - Required - The number of refills allowed (0-99).
  - **DaysSupply** (integer) - Optional - The number of days the supply is intended for (0-365).
  - **DispenseUnitId** (integer) - Required - The ID of the dispense unit.
  - **Quantity** (number) - Required - The quantity of the medication to dispense.
  - **Directions** (string) - Required - The directions for taking the medication (max 1000 characters).
  - **PharmacyId** (integer) - Optional - The ID of the pharmacy.
  - **PharmacyNotes** (string) - Optional - Notes for the pharmacy (max 210 characters).
  - **NoSubstitutions** (boolean) - Optional - Indicates if substitutions are not allowed.
  - **EffectiveDate** (string) - Optional - The effective date of the prescription (ISO 8601 format).
  - **RxReferenceNumber** (string) - Optional - A reference number for the prescription (max 35 characters).
  - **EligibilityId** (integer) - Optional - The ID for eligibility.
  - **NonDoseSpotPrescriptionId** (string) - Optional - A non-DoseSpot prescription ID (max 35 characters).
  - **FirstPrescriptionDiagnosis** (object) - Optional - Details of the first prescription diagnosis.
  - **SecondPrescriptionDiagnosis** (object) - Optional - Details of the second prescription diagnosis.
  - **IsRefillReplace** (boolean) - Optional - Indicates if this is a refill replacement.
  - **IsUrgent** (boolean) - Optional - Indicates if the prescription is urgent.
  - **SupervisorId** (integer) - Optional - The ID of the supervisor.
  - **RetailPharmacyToMailToPatient** (boolean) - Optional - Indicates if retail pharmacy should mail to patient.
  - **RTPSCoupon** (object) - Optional - Coupon details for RTPS.
    - **BIN** (string) - Optional - BIN number.
    - **PCN** (string) - Optional - PCN number.
    - **MemberID** (string) - Optional - Member ID.
    - **GroupID** (string) - Optional - Group ID.
  - **Status** (string) - Required - The status of the prescription (e.g., 'Active', 'Inactive'). Enum: ["Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill"]
  - **InactiveDate** (string) - Optional - The date the prescription becomes inactive (ISO 8601 format).
  - **Comment** (string) - Optional - A comment for the prescription (max 500 characters).
  - **Encounter** (string) - Optional - Encounter details (max 50 characters).

### Request Example
```json
{
  "DispensableDrugId": 12345,
  "Refills": 3,
  "DispenseUnitId": 1,
  "Quantity": 30.0,
  "Directions": "Take one tablet by mouth daily.",
  "Status": "Active"
}
```

### Response
#### Success Response (200)
- **PrescriptionId** (integer) - The ID of the created prescription.
- **Message** (string) - A success message.

#### Response Example
```json
{
  "PrescriptionId": 98765,
  "Message": "Coded prescription created successfully."
}
```
```

--------------------------------

### POST /api/clinics

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Adds a new clinic to the system.

```APIDOC
## POST /api/clinics

### Description
Adds a new clinic to the system.

### Method
POST

### Endpoint
/api/clinics

### Parameters
#### Request Body
- **request** (object) - Required - New clinic data
  - **name** (string) - Required - The name of the new clinic.
  - **address** (string) - Required - The address of the new clinic.
  - **phoneNumber** (string) - Required - The phone number of the new clinic.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the newly created clinic.

#### Response Example
```json
{
  "id": 456
}
```
```

--------------------------------

### GET /api/patients

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a list of patients, with options to filter by status and paginate results.

```APIDOC
## GET /api/patients

### Description
Retrieves a list of patients. You can filter by patient status (ActiveOnly, InactiveOnly, Both) and specify the page number for pagination.

### Method
GET

### Endpoint
/api/patients

### Parameters
#### Query Parameters
- **status** (string) - Optional - Patient Status to include (if none supplied defaults to both). Enum: ["InactiveOnly", "ActiveOnly", "Both"]
- **pageNumber** (integer) - Optional - Page Number

### Response
#### Success Response (200)
- **PagedListResponse[Patient]** - A paginated list of patient objects.

#### Response Example
{
  "example": "{\"items\": [...], \"pageCount\": 10, \"totalCount\": 100}"
}
```

--------------------------------

### GET /api/patients/{patientId}/narx/report

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Returns the URL to the patient's NARx report.

```APIDOC
## GET /api/patients/{patientId}/narx/report

### Description
Returns the url to the Narx Report for the patient.

### Method
GET

### Endpoint
/api/patients/{patientId}/narx/report

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - PatientId

### Response
#### Success Response (200)
- **schema** (object) - Reference to the ItemResponse[String] definition.
```

--------------------------------

### POST /api/patients

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Creates a new patient record in the system.

```APIDOC
## POST /api/patients

### Description
Creates a new patient and returns the corresponding patient ID.

### Method
POST

### Endpoint
/api/patients

### Parameters
#### Request Body
- **request** (object) - Required - New patient data. Schema: `#/definitions/AddEditPatientRequest`

### Request Example
{
  "example": "{\"firstName\": \"John\", \"lastName\": \"Doe\", ...}"
}

### Response
#### Success Response (200)
- **IdentifierResponse** - An object containing the ID of the newly created patient.

#### Response Example
{
  "example": "{\"id\": 12345}"
}
```

--------------------------------

### GET /api/dispenseUnits/{dispenseUnitId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves the details of a specific dispense unit type by its ID.

```APIDOC
## GET /api/dispenseUnits/{dispenseUnitId}

### Description
Lists the details of a specified dispense unit type.

### Method
GET

### Endpoint
/api/dispenseUnits/{dispenseUnitId}

### Parameters
#### Path Parameters
- **dispenseUnitId** (integer) - Required - Dispense units id

### Response
#### Success Response (200)
- **schema** (object) - Reference to the StandardDispenseUnitType definition.
```

--------------------------------

### GET /api/patients/{patientId}/clinics

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a list of all clinics associated with a specific patient.

```APIDOC
## GET /api/patients/{patientId}/clinics

### Description
Retrieves a list of all clinics associated with a specific patient.

### Method
GET

### Endpoint
/api/patients/{patientId}/clinics

### Parameters
#### Path Parameters
- **patientId** (integer) - Required - Patient ID

### Response
#### Success Response (200)
- **items** (array) - An array of Clinic objects associated with the patient.

#### Response Example
```json
[
  {
    "id": 101,
    "name": "Patient Clinic Alpha"
  },
  {
    "id": 102,
    "name": "Patient Clinic Beta"
  }
]
```
```

--------------------------------

### GET /api/clinics/{clinicId}

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves detailed information for a specific clinic using its ID.

```APIDOC
## GET /api/clinics/{clinicId}

### Description
Retrieves detailed information for a specific clinic using its ID.

### Method
GET

### Endpoint
/api/clinics/{clinicId}

### Parameters
#### Path Parameters
- **clinicId** (integer) - Required - Clinic ID

### Response
#### Success Response (200)
- **id** (integer) - The clinic's unique identifier.
- **name** (string) - The name of the clinic.
- **address** (string) - The address of the clinic.
- **phoneNumber** (string) - The phone number of the clinic.

#### Response Example
```json
{
  "id": 123,
  "name": "Example Clinic",
  "address": "123 Main St",
  "phoneNumber": "555-1234"
}
```
```

--------------------------------

### GET /api/prescriptions/{prescriptionId}/prescriberInfo

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves the prescriber's information for a given prescription.

```APIDOC
## GET /api/prescriptions/{prescriptionId}/prescriberInfo

### Description
Get a Prescription's prescriber Information.

### Method
GET

### Endpoint
/api/prescriptions/{prescriptionId}/prescriberInfo

### Parameters
#### Path Parameters
- **prescriptionId** (integer) - Required - The prescription Id

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **PrescriberInfoResponse** (object) - OK (schema: #/definitions/PrescriberInfoResponse)

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### POST /api/priorAuths/{priorAuthId}/denied

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Denies a prior authorization case, whether it is offline or online.

```APIDOC
## POST /api/priorAuths/{priorAuthId}/denied

### Description
Denies offline or online prior authorization cases.

### Method
POST

### Endpoint
/api/priorAuths/{priorAuthId}/denied

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - priorAuthCaseId

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body"
}
```

### Response
#### Success Response (200)
- **Response** (object) - Standard response object indicating success.

#### Response Example
```json
{
  "example": "Response object"
}
```
```

--------------------------------

### GET /api/clinicians/{clinicianId}/prescriptionFavorites

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Retrieves a list of clinician's favorite prescriptions.

```APIDOC
## GET /api/clinicians/{clinicianId}/prescriptionFavorites

### Description
Retrieves a list of clinician's favorite prescriptions.

### Method
GET

### Endpoint
/api/clinicians/{clinicianId}/prescriptionFavorites

### Parameters
#### Path Parameters
- **clinicianId** (integer) - Required - clinician Id

#### Query Parameters
- **favoriteType** (string) - Optional - Enum: All, Medication, Supply, CompiledCompound
- **pageNumber** (integer) - Optional - Minimum: 1, Maximum: 2147483645
- **pageSize** (integer) - Optional - Minimum: 1, Maximum: 100
- **searchName** (string) - Optional - Minimum length: 2

### Response
#### Success Response (200)
- **pagedListResponse[ClinicianFavoritePrescriptionResponse]** (object) - OK
  - *See DoseSpot API documentation for schema details.*

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### POST /api/priorAuths/{priorAuthId}/questions/{questionId}/answer

Source: https://my.staging.dosespot.com/webapi/v2/swagger/docs/Full_EPCSV2

Adds an answer to a specific question within a prior authorization case.

```APIDOC
## POST /api/priorAuths/{priorAuthId}/questions/{questionId}/answer

### Description
Adds an answer to a single question of a prior authorization case.

### Method
POST

### Endpoint
/api/priorAuths/{priorAuthId}/questions/{questionId}/answer

### Parameters
#### Path Parameters
- **priorAuthId** (integer) - Required - Prior Authorization Case ID
- **questionId** (integer) - Required - Prior Authorization Question ID

#### Query Parameters
None

#### Request Body
- **request** (PriorAuthorizationAnswer) - Required - The answer to the prior authorization question.

### Request Example
```json
{
  "example": "PriorAuthAnswerRequest body"
}
```

### Response
#### Success Response (200)
- **PriorAuthAnswerSingleQuestionResponse** (object) - Response containing the result of answering the question.

#### Response Example
```json
{
  "example": "PriorAuthAnswerSingleQuestionResponse object"
}
```
```
Tokens:
Raw