openapi: 3.2.0
info:
  title: Truepill API documentation Fill Requests API
  version: 0.0.1
  description: DOCS
servers:
- url: https://rxapi.fuzehealth.com/
- url: http://rxapi.fuzehealth.com/
security:
- apiKey: []
tags:
- name: Fill Requests
paths:
  /v1/fill_requests:
    get:
      summary: Get a list of fill requests
      operationId: getV1Fill_requests
      description: Returns a list of fill requests and allows for the use of query parameters to scope the results of the request
      parameters:
      - name: created_at
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: number
          maximum: 100
      - name: next
        in: query
        schema:
          type: string
      - name: metadata
        in: query
        schema:
          type: string
      tags:
      - Fill Requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model22'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model9'
  /api/v1/fill_requests:
    get:
      summary: Get a list of fill requests
      operationId: getApiV1Fill_requests
      description: Returns a list of fill requests and allows for the use of query parameters to scope the results of the request
      parameters:
      - name: created_at
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: number
          maximum: 100
      - name: next
        in: query
        schema:
          type: string
      - name: metadata
        in: query
        schema:
          type: string
      tags:
      - Fill Requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model22'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model9'
components:
  schemas:
    otc_products:
      type: array
      items:
        $ref: '#/components/schemas/otc_product'
    Model20:
      type: object
      properties:
        category:
          type: string
          example: prescription_copay
          enum:
          - prescription_copay
          - tax
          - shipping
          - prescription_cash
          - tax_copay
          - processing_fee
        prescription_token:
          type: string
          example: 0154cc7b065
        amount:
          type: number
          example: 11.43
        description:
          type: string
          example: Copay for medication A
      required:
      - category
      - prescription_token
      - amount
    results:
      type: array
      items:
        $ref: '#/components/schemas/Model21'
    Model22:
      type: object
      properties:
        results:
          $ref: '#/components/schemas/results'
        next_page_token:
          type: string
          example: JpdiI6IjdkNWViNWU5MTViNjAzNzAwYjQ4NTI3YjEyZjIzNDFkIiwiY29udGVudCI6IjE2YTcyNmQ4OGI3NTNlYzRjMTE5ZDc5NWIyMmE4MDRkN2UzYzA3YTA1M
    Model9:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: An internal server error occurred
        message:
          type: string
          example: An internal server error occurred
    medication_response:
      type: object
      properties:
        prescription_token:
          type: string
          example: e61e324f9018
        quantity:
          type: number
          example: 30
        is_cancellable:
          type: boolean
          description: Indicates whether this medication/fill can be cancelled.
          example: true
    patient_consent:
      type: object
      properties:
        consent_statement:
          type: string
        consent_method:
          type: string
        consent_date:
          type: string
        consent_type:
          type: string
        patient_name:
          type: string
        consent_provided_by:
          type: string
        item:
          type: string
    medications:
      type: array
      items:
        $ref: '#/components/schemas/medication_response'
    current_stripe_payment:
      type: object
      properties:
        cardholder_name:
          type: string
          example: Bruce Banner
        last_four_digits:
          type: string
          example: '6789'
        stripe_id:
          type: string
          example: pi_10f410zj3018s2
        amount:
          type: number
          example: 12.75
        description:
          type: string
          example: Paid by patient
        intent_status:
          type: string
      required:
      - stripe_id
      - amount
    otc_product:
      type: object
      properties:
        sku:
          type: string
          example: SKU-123-456
        quantity:
          type: number
          example: 1
        patient_consent:
          $ref: '#/components/schemas/patient_consent'
        is_cancellable:
          type: boolean
          description: Indicates whether this OTC product can be cancelled. False if packing slip has been printed.
          example: true
    Model21:
      type: object
      properties:
        patient_first_name:
          type: string
          example: Stephen
        patient_last_name:
          type: string
          example: Strange
        metadata:
          type: string
          example: some metadata
        patient_payment_type:
          type: string
          example: cash
        is_cancellable:
          type: boolean
          description: Indicates whether the entire fill request can be cancelled based on its current status. Generally true when order is in Triage or PV1 status, false when in Fill, PV2, Packing, Complete, or Cancelled status.
          example: true
        address_to_name:
          type: string
          example: Stephen Strange
        address_to_street1:
          type: string
          example: 1700 S Amphlett Blvd
        address_to_street2:
          type: string
          example: '#221'
        address_to_city:
          type: string
          example: San Mateo
        address_to_state:
          type: string
          example: CA
        address_to_phone:
          type: string
          example: '1112223333'
        address_to_email:
          type: string
          example: truepill@truepill.com
        address_to_zip:
          type: string
          example: '94402'
        patient_survey:
          $ref: '#/components/schemas/patient_survey'
        medications:
          $ref: '#/components/schemas/medications'
        otc_products:
          $ref: '#/components/schemas/otc_products'
        shipping_method:
          type: string
          example: standard
        address_to_company:
          type: string
        address_to_country:
          type: string
          example: US
        status:
          type: string
          example: triage
        url_token:
          type: string
          example: abc123
        created_at:
          type: string
          example: '2021-09-14T14:22:37.000Z'
        tracking_url:
          type: string
          example: https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=us&trackingnumber=12345
        receipt_items:
          $ref: '#/components/schemas/receipt_items'
        current_stripe_payment:
          $ref: '#/components/schemas/current_stripe_payment'
      required:
      - patient_survey
    patient_survey:
      type: object
      example:
        medications: Tafluprost
        allergies: Penicillian
        conditions: Glaucoma
      properties:
        allergies:
          type: string
          x-alternatives:
          - type: string
          - $ref: '#/x-alt-definitions/allergies'
        medications:
          type: string
          x-alternatives:
          - type: string
          - $ref: '#/x-alt-definitions/medications'
        conditions:
          type: string
        events:
          type: string
          x-alternatives:
          - type: string
          - $ref: '#/x-alt-definitions/events'
        smoking_frequency:
          type: string
        drinking_frequency:
          type: string
        asthma_breathing:
          type: boolean
        heart_disease:
          type: boolean
        arthritis:
          type: boolean
        lung_disorder:
          type: boolean
        bleeding_clotting_disorder:
          type: boolean
        neurological_chronic_headaches:
          type: boolean
        blood_transfusion:
          type: boolean
        psychiatric_disorder:
          type: boolean
        bowel_stomach:
          type: boolean
        pulmonary_embolism:
          type: boolean
        cancer:
          type: boolean
        stroke:
          type: boolean
        cholesterol_disorder:
          type: boolean
        seizure_epilepsy:
          type: boolean
        diabetes:
          type: boolean
        thyroid_disorder:
          type: boolean
        eye_disorder:
          type: boolean
        urinary_kidney_disorder:
          type: boolean
        pregnancy:
          type: boolean
      required:
      - allergies
      - medications
      - conditions
    receipt_items:
      type: array
      items:
        $ref: '#/components/schemas/Model20'
  securitySchemes:
    apiKey:
      type: apiKey
      name: Authorization
      in: header
x-alt-definitions:
  selected_allergies:
    type: array
    items:
      type: string
  allergies:
    type: object
    properties:
      selected_allergies:
        $ref: '#/x-alt-definitions/selected_allergies'
      presented_allergies:
        $ref: '#/x-alt-definitions/selected_allergies'
      free_form_allergy_information:
        type: string
    required:
    - selected_allergies
    - presented_allergies
    - free_form_allergy_information
  Model1:
    type: object
    properties:
      name:
        type: string
      strength:
        type: number
      dosage:
        type: string
      frequency:
        type: string
    required:
    - name
  medications:
    type: array
    items:
      $ref: '#/x-alt-definitions/Model1'
  Model2:
    type: object
    properties:
      type:
        type: string
      year:
        type: number
      reason:
        type: string
    required:
    - type
    - year
    - reason
  events:
    type: array
    items:
      $ref: '#/x-alt-definitions/Model2'
  patient_consent:
    type: object
    properties:
      consent_statement:
        type: string
      consent_method:
        type: string
      consent_date:
        type: string
      consent_type:
        type: string
      patient_name:
        type: string
      consent_provided_by:
        type: string
      item:
        type: string
  Model3:
    type: object
    properties:
      insurance_token:
        type: string
        description: Insurance token
        example: adcbc795028c009d
        minLength: 1
      prior_authorization_number:
        type: string
        example: ABC123
        pattern: ^[0-9a-zA-Z]{1,35}$
      other_coverage_code:
        type: string
        example: '8'
        pattern: ^[0-8]{1}$
      submission_clarification_code:
        type: string
        example: '3'
        pattern: ^(?:[1-9]\d?|0)$
    required:
    - insurance_token
  claim_overrides:
    type: array
    items:
      $ref: '#/x-alt-definitions/Model3'
  pricing:
    type: object
    properties:
      ingredient_cost_submitted:
        type: number
        x-constraint:
          greater: 0
          precision: 2
  Model4:
    type: object
    properties:
      prescription_token:
        type: string
        description: Prescription token
        example: 4526d90a
        minLength: 1
      quantity:
        type: number
        example: 8.7
      days_supply:
        type: number
        example: 30
      patient_consent:
        $ref: '#/x-alt-definitions/patient_consent'
      claim_overrides:
        $ref: '#/x-alt-definitions/claim_overrides'
      ndc:
        type: string
        description: National drug code
        example: '71858002504'
        pattern: ^[0-9]{10,11}$
      daw:
        type: string
        example: '2'
        enum:
        - '0'
        - '2'
      copay_limit:
        type: number
        minimum: 0
        x-constraint:
          precision: 2
      pricing:
        $ref: '#/x-alt-definitions/pricing'
    required:
    - prescription_token
    - daw
  insurance_token:
    type: array
    example:
    - skhsyq83rkd3uht9
    - ubqfc1a0a17hjb1c
    - oi4aafwcsv5zzvvj
    minItems: 1
    items:
      type: string
  copay_payment:
    type: object
    properties:
      cardholder_name:
        type: string
        description: Cardholder name
        example: John Doe
      payment_type:
        type: string
      last_four_digits:
        type: string
        example: '4132'
      transaction_amount:
        type: number
      card_type:
        type: string
      transaction_date:
        type: string
      transaction_id:
        type: string
    required:
    - payment_type
  Medication:
    type: object
    description: Medication description
    example:
    - prescription_token: z3q2jr
    - prescription_token: 3cs873
    properties:
      medication_name:
        type: string
        description: Medication name
        example: Ritalin
        maxLength: 255
      quantity_dispensed:
        type: number
        description: Dispensed medication quantity
        example: 60
      days_supply:
        type: number
        description: Days supply
        example: 30
      is_refill:
        type: boolean
        description: Is prescription a refill or new fill
        example: true
      medication_sig:
        type: string
        description: Recommendations for medicines
        example: Apply daily.
      prescribing_doctor:
        type: string
        description: Prescribing doctor
        example: Dr. Storm
      prescription_token:
        type: string
        description: Prescription token
        example: 4526d90a
        minLength: 1
      rx_link:
        type: string
        minLength: 1
      quantity:
        type: number
        description: Quantity sent
        example: 30
        x-constraint:
          greater: 0
      copay_payment:
        $ref: '#/x-alt-definitions/copay_payment'
      ndc:
        type: string
        description: National drug code
        example: '12345678901'
        pattern: ^[0-9]{11}$
      daw:
        type: string
        example: '2'
        enum:
        - '0'
        - '2'
      patient_consent:
        $ref: '#/x-alt-definitions/patient_consent'
    required:
    - daw
  MedicationArray:
    type: array
    x-constraint: {}
    items:
      $ref: '#/x-alt-definitions/Medication'
  auto_refill:
    type: object
    properties:
      date_provided:
        type: string
        format: date
        description: Date of consent
        example: '2022-05-12'
      consent_statement:
        type: string
        description: Statement confirming consent
        example: I consent
    required:
    - date_provided
    - consent_statement
  Model5:
    type: object
    properties:
      consent_statement:
        type: string
      consent_method:
        type: string
      consent_date:
        type: string
      consent_type:
        type: string
      patient_name:
        type: string
      consent_provided_by:
        type: string
      item:
        type: string
      auto_refill:
        $ref: '#/x-alt-definitions/auto_refill'
  Model6:
    type: object
    description: Medication description
    example:
    - prescription_token: z3q2jr
    - prescription_token: 3cs873
    properties:
      medication_name:
        type: string
        description: Medication name
        example: Ritalin
        maxLength: 255
      quantity_dispensed:
        type: number
        description: Dispensed medication quantity
        example: 60
      days_supply:
        type: number
        description: Days supply
        example: 30
      is_refill:
        type: boolean
        description: Is prescription a refill or new fill
        example: true
      medication_sig:
        type: string
        description: Recommendations for medicines
        example: Apply daily.
      prescribing_doctor:
        type: string
        description: Prescribing doctor
        example: Dr. Storm
      prescription_token:
        type: string
        description: Prescription token
        example: 4526d90a
        minLength: 1
      rx_link:
        type: string
        minLength: 1
      quantity:
        type: number
        description: Quantity sent
        example: 30
        x-constraint:
          greater: 0
      copay_payment:
        $ref: '#/x-alt-definitions/copay_payment'
      ndc:
        type: string
        description: National drug code
        example: '12345678901'
        pattern: ^[0-9]{11}$
      daw:
        type: string
        example: '2'
        enum:
        - '0'
        - '2'
      patient_consent:
        $ref: '#/x-alt-definitions/Model5'
    required:
    - daw
  Model7:
    type: array
    x-constraint: {}
    items:
      $ref: '#/x-alt-definitions/Model6'
  Shipping Address:
    type: object
    properties:
      name:
        type: string
        minLength: 1
      company:
        type: string
        minLength: 0
      street1:
        type: string
        description: Primary street of the address
        minLength: 1
      street2:
        type: string
        description: Secondary street
        minLength: 0
      city:
        type: string
        description: City
        minLength: 1
      state:
        type: string
        description: State
        minLength: 1
      zip:
        type: string
        minLength: 0
        pattern: ^\d{5}(-\d{4})?$
      country:
        type: string
        description: Country
        default: US
        minLength: 1
      phone:
        type: string
        minLength: 0
      email:
        type: string
        minLength: 1
      fax:
        type: string
        minLength: 0
    required:
    - name
    - street1
    - city
    - state
    - zip
    - country
    - email
  shipping_address:
    type: object
    properties:
      phone:
        type: string
        minLength: 0
    required:
    - phone
  external_location:
    type: object
    properties:
      id:
        type: string
        description: 'Stringified UUIDv4.

          See [RFC 4112](https://tools.ietf.org/html/rfc4122)'
        minLength: 0
        pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$
      pharmacy:
        type: string
        description: References GET /v1/external_location_pharmacies
        minLength: 0
      npi:
        type: string
        description: NPI - likely type 2
        minLength: 0
        maxLength: 10
        pattern: ^[0-9]{10}$
      address_to_street1:
        type: string
        minLength: 0
      address_to_street2:
        type: string
        minLength: 0
      address_to_city:
        type: string
        minLength: 0
      address_to_state:
        type: string
        minLength: 0
        pattern: ^[A-Z]{2}$
      address_to_zip:
        type: string
        minLength: 0
        pattern: ^\d{5}(-?\d{4})?$
      address_to_country:
        type: string
        minLength: 0
        pattern: ^[A-Z]{2}$
      address_to_phone:
        type: string
        minLength: 0
        pattern: ^(\+)?[1-9]\d{1,14}$
      address_to_fax:
        type: string
        description: The fax number of the address
        minLength: 0
        maxLength: 255
        pattern: ^[1-9]\d{1,14}$
    required:
    - id
    - pharmacy
    - npi
    - address_to_street1
    - address_to_city
    - address_to_state
    - address_to_zip
    - address_to_country
  Model8:
    type: object
    properties:
      ncpdpid:
        type: string
        description: NCPDP ID - National Council for Prescription Drug Programs
        minLength: 0
      distance_from_origin:
        type: number
        description: Approximate distance rounded to nearest 0.01 mile
    required:
    - ncpdpid