openapi: 3.2.0
info:
  title: Truepill API documentation Prescriber API
  version: 0.0.1
  description: DOCS
servers:
- url: https://rxapi.fuzehealth.com/
- url: http://rxapi.fuzehealth.com/
security:
- apiKey: []
tags:
- name: Prescriber
paths:
  /v1/prescriber/{prescriber_token}:
    get:
      summary: Get Prescriber
      operationId: getV1PrescriberPrescriber_token
      description: Get the prescriber information at any time using the `prescriber_token` that was provided in the Create Prescriber response
      parameters:
      - description: Prescriber token
        name: prescriber_token
        in: path
        required: true
        schema:
          type: string
      tags:
      - Prescriber
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model60'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model61'
  /api/v1/prescriber/{prescriber_token}:
    get:
      summary: Get Prescriber
      operationId: getApiV1PrescriberPrescriber_token
      description: Get the prescriber information at any time using the `prescriber_token` that was provided in the Create Prescriber response
      parameters:
      - description: Prescriber token
        name: prescriber_token
        in: path
        required: true
        schema:
          type: string
      tags:
      - Prescriber
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model60'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model61'
  /v1/prescriber:
    post:
      summary: Create Prescriber
      operationId: postV1Prescriber
      description: Create a prescriber in the Truepill ecosystem that is assigned to you as a customer
      tags:
      - Prescriber
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model164'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model167'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model163'
  /api/v1/prescriber:
    post:
      summary: Create Prescriber
      operationId: postApiV1Prescriber
      description: Create a prescriber in the Truepill ecosystem that is assigned to you as a customer
      tags:
      - Prescriber
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model164'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model167'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model163'
components:
  schemas:
    Model163:
      type: object
      properties:
        prescriber_type:
          type: string
          example: OD
          enum:
          - OD
          - PMHNP
          - MBBS
          - DNP
          - D.O.
          - DPT
          - D.D.S.
          - F.N.P.
          - CPP
          - N.D.
          - P.A.
          - APNP
          - V.M.D.
          - RPh
          - APRN
          - DC APC
          - PsyD
          - CRNA
          - PharmD
          - B.V.M.S.
          - WHNP
          - PhD
          - ARNP
          - PT
          - CRNP
          - DPM
          - CNP
          - N.P.
          - CDH
          - D.M.D.
          - D.V.M.
          - M.D.
          - CNM
        first_name:
          type: string
          description: Prescriber’s first name
          example: 'True'
        last_name:
          type: string
          description: Prescriber’s last name
          example: Pill
        dea:
          type: string
          description: Prescriber’s DEA license ID
          example: BI7884668
        npi:
          type: string
          description: Prescriber’s National Provider Identifier
          example: '2888888888'
        active:
          type: boolean
          description: Whether the prescriber is actively prescribing
          example: true
        address:
          $ref: '#/components/schemas/Model162'
      required:
      - first_name
      - last_name
      - npi
      - active
      - address
    Model164:
      type: object
      properties:
        prescriber_token:
          type: string
          example: e9c4778365b209a81bc9
    Model162:
      type: object
      description: Prescriber's address details
      properties:
        clinic_name:
          type: string
          description: Clinic name that the prescriber works at
          example: True Clinic
        street1:
          type: string
          description: Street 1 of prescriber’s working address
          example: 3121 Diablo Ave
        street2:
          type: string
          description: Street 2 of prescriber’s working address
          example: 123 Some Lane
        city:
          type: string
          description: City of prescriber’s working address
          example: Hayward
        state:
          type: string
          description: State of prescriber’s working address. Two-letter state abbreviation
          example: CA
        country:
          type: string
          description: US (default)
          example: US
          default: US
        zip:
          type: string
          description: Zip code of prescriber’s working address
          example: '94545'
          pattern: ^\d{5}(-\d{4})?$
        phone:
          type: string
          description: Prescriber’s phone number
          example: (855) 910-8606
        email:
          type: string
          description: Prescriber’s email
          example: truepill@truepill.com
          x-format:
            email: true
        fax:
          type: string
          description: Prescriber’s fax number
          example: (855) 910-8606
      required:
      - street1
      - city
      - state
      - zip
      - phone
    Model165:
      type: object
      properties:
        key:
          type: string
          example: address.phone
        message:
          type: string
          example: is required
    Model60:
      type: object
      properties:
        prescriber_type:
          type: string
          example: OD
        first_name:
          type: string
          description: Prescriber’s first name
          example: Bruce
        last_name:
          type: string
          description: Prescriber’s last name
          example: Banner
        dea:
          type: string
          description: Prescriber’s DEA license ID
          example: BI7884668
        npi:
          type: string
          description: Prescriber’s National Provider Identifier
          example: '1497742761'
        address:
          $ref: '#/components/schemas/Model59'
        prescriber_token:
          type: string
          example: b6aba8097c2059820fb3
      required:
      - first_name
      - last_name
    Model59:
      type: object
      description: Prescriber's address details
      properties:
        name:
          type: string
          description: Clinic name that the prescriber works at
          example: Test clinic
        street1:
          type: string
          description: Street 1 of prescriber’s working address
          example: 123 Some Lane
        street2:
          type: string
          description: Street 2 of prescriber’s working address
          example: Apt. 123
        city:
          type: string
          description: City of prescriber’s working address
          example: Los Angeles
        state:
          type: string
          description: State of prescriber’s working address. Two-letter state abbreviation
          example: CA
        zip:
          type: string
          description: Zip code of prescriber’s working address
          example: '01000'
        country:
          type: string
          description: US (default)
          example: US
        phone:
          type: string
          description: Prescriber’s phone number
          example: '4303043949'
        email:
          type: string
          description: Prescriber’s email
          example: hulkout@hulk.com
        fax:
          type: string
          description: Prescriber’s fax number
          example: '430304394'
    Model61:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Unable to find Prescriber.
    Model167:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        validation_errors:
          $ref: '#/components/schemas/Model166'
    Model166:
      type: array
      items:
        $ref: '#/components/schemas/Model165'
  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