# Cancel a prescription

Endpoint: DELETE /prescriptions/{external_id}
Version: 2024-12-10
Security: BearerAuth

## Path parameters:

  - `external_id` (string, required)

## Response 200 fields (application/json):

  - `prescription` (object)

  - `prescription.external_id` (string, required)
    Unique identifier for this prescription, provided by the prescriber

  - `prescription.written_date` (string, required)

  - `prescription.number_of_refills` (integer, required)

  - `prescription.substitutions` (integer, required)
    NCPDP Dispense As Written/Product Selection Code. E.g. 0 for No Product Selection Indicated and 1 for Substitution Not Allowed by Prescriber

  - `prescription.sig_text` (string)

  - `prescription.note` (string)

  - `prescription.cancellation_requested_at` (string,null)
    A non-null value for this field indicates that the script has been flagged for Gifthealth to cancel the prescription as soon as possible.

  - `prescription.patient` (object, required)

  - `prescription.patient.first_name` (string, required)

  - `prescription.patient.middle_name` (string,null)

  - `prescription.patient.last_name` (string, required)

  - `prescription.patient.dob` (string, required)

  - `prescription.patient.gender` (string, required)
    Enum: "M", "F", "N", "U"

  - `prescription.patient.primary_phone` (string, required)

  - `prescription.patient.email` (string,null)

  - `prescription.patient.address` (object, required)

  - `prescription.patient.address.address1` (string, required)

  - `prescription.patient.address.address2` (string,null)

  - `prescription.patient.address.city` (string, required)

  - `prescription.patient.address.state` (string, required)
    Two-letter state abbreviation. Fifty US states and DC only.

  - `prescription.patient.address.zip` (string, required)
    Five-digit ZIP code.

  - `prescription.medication` (object, required)

  - `prescription.medication.name` (string, required)

  - `prescription.medication.ndc` (string, required)
    NDC code for a medication dispensed by Gifthealth.
    Enum: "00002015204", "00002024304", "00002121404", "00002134004", "00002142304", "00002200204"

  - `prescription.medication.quantity` (string, required)

  - `prescription.medication.quantity_unit_code` (string, required)
    NCPDP Quantity Unit of Measure Code. E.g. C28254 for Milliliters, C64933 for Each

  - `prescription.medication.days_supply` (integer,null)

  - `prescription.medication.diagnosis` (object)

  - `prescription.medication.diagnosis.primary_icd10_code` (string, required)

  - `prescription.medication.diagnosis.primary_icd10_description` (string, required)

  - `prescription.medication.diagnosis.secondary_icd10_code` (string,null)

  - `prescription.medication.diagnosis.secondary_icd10_description` (string,null)

  - `prescription.prescriber` (object, required)

  - `prescription.prescriber.npi` (string, required)

  - `prescription.prescriber.fax` (string,null)

  - `prescription.pharmacy` (object, required)

  - `prescription.pharmacy.ncpdpid` (string, required)

  - `prescription.allergies` (array, required)
    An empty array indicates No Known Allergies. If the patient's allergy history is unknown, this will be null.

  - `prescription.allergies.source_of_information` (string, required)
    Indicates where the sender received the allergy information if known. P for patient or patient representative or personal health record (PHR), C for clinician or provider, O for other source
    Enum: "C", "P", "O"

  - `prescription.allergies.effective_date` (string,null)

  - `prescription.allergies.adverse_event` (object, required)

  - `prescription.allergies.adverse_event.text` (string, required)

  - `prescription.allergies.adverse_event.code` (string,null)
    SNOMED code for the adverse event.

  - `prescription.allergies.drug_product` (object, required)

  - `prescription.allergies.drug_product.code` (string,null)
    SNOMED code for the drug product.

  - `prescription.allergies.severity` (object)

  - `prescription.allergies.severity.code` (string,null)
    SNOMED code for the severity.

  - `prescription.originating_entity` (string)

## Response 401 fields (application/json):

  - `error` (string)

## Response 404 fields (application/json):

  - `error` (string)