openapi: 3.2.0
info:
  title: Dosespot Rx Changes API
  version: '1.0'
  description: 'Operations tagged RxChanges across 2 of this provider''s published API definitions: dosespot-rest-api-full-epcs-v2-swagger.json, dosespot-rest-api-jumpstart-epcs-v2-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
- url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/JumpStart_EPCSV2
tags:
- name: RxChanges
paths:
  /api/rxchanges/pending:
    get:
      tags:
      - RxChanges
      summary: Get Clinician's Rx Change requests for clinic(s)/patient
      description: Lists the number of notifications for pending RxChange requests associated with clinician's clinic(s)/patient
      operationId: RxChanges_GetRxChangeQueueV2
      parameters:
      - name: clinic
        in: query
        required: false
        schema:
          type: string
          enum:
          - All
          - Current
          maximum: 1
          minimum: 0
      - name: patientId
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        required: false
        schema:
          type: integer
          format: int32
          maximum: 2147483647
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeResponse'
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
  /api/rxchanges/pending/detailed:
    get:
      tags:
      - RxChanges
      summary: Get Clinician's Rx Change requests for clinic(s)/patient
      description: 'Lists the number of notifications for pending RxChange requests associated with clinician''s clinic(s)/patient.

        Includes detailed prescription information.'
      operationId: RxChanges_GetRxChangeQueueDetailedV2
      parameters:
      - name: clinic
        in: query
        required: false
        schema:
          type: string
          enum:
          - All
          - Current
          maximum: 1
          minimum: 0
      - name: patientId
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        required: false
        schema:
          type: integer
          format: int32
          maximum: 2147483647
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeDetailedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeDetailedResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeDetailedResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeDetailedResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/PagedListResponse_GetRxChangeDetailedResponse'
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
  /api/rxchanges/{rxChangeId}/deny:
    post:
      tags:
      - RxChanges
      summary: Denies a pending rxChange request
      description: Denies a pending rxChange request by providing a reason
      operationId: RxChanges_DenyRxChangeV2
      parameters:
      - name: rxChangeId
        in: path
        description: rxChange ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            text/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Response'
            application/xml:
              schema:
                $ref: '#/components/schemas/Response'
            text/xml:
              schema:
                $ref: '#/components/schemas/Response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
          application/problem+json:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DenyRxChangeRequest'
        description: rxChange Data
        required: true
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
  /api/rxchanges/{rxChangeId}/approve:
    post:
      tags:
      - RxChanges
      summary: Approves a pending rxChange request
      description: Approves a pending rxChange request by adding a new prescription details
      operationId: RxChanges_ApproveRxChangeV2
      parameters:
      - name: rxChangeId
        in: path
        description: rxChange ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentifierResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/IdentifierResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/IdentifierResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/IdentifierResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/IdentifierResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
          application/problem+json:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ApproveRxChangeRequest'
        description: rxChange Data
        required: true
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
  /api/rxchanges/{rxChangeId}/patients/{patientId}/reconcile:
    post:
      tags:
      - RxChanges
      summary: Reconcile Rx. Change
      description: Links an existing Rx. Change request to a patient record
      operationId: RxChanges_ReconcileRxChangeV2
      parameters:
      - name: patientId
        in: path
        description: Patient ID
        required: true
        schema:
          type: integer
          format: int32
      - name: rxChangeId
        in: path
        description: rxChange ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            text/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Response'
            application/xml:
              schema:
                $ref: '#/components/schemas/Response'
            text/xml:
              schema:
                $ref: '#/components/schemas/Response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
          application/problem+json:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ReconcileRxChangeRequest'
        description: Referenced Prescription ID
        required: true
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
  /api/rxchanges/{rxChangeId}/changePatient:
    patch:
      tags:
      - RxChanges
      summary: Change patient details in a rxchange request
      description: Links the rxChange request to a different, existing patient in the same clinic
      operationId: RxChanges_ChangeRxChangeRequestPatientV2
      parameters:
      - name: rxChangeId
        in: path
        description: rxChange ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            text/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Response'
            application/xml:
              schema:
                $ref: '#/components/schemas/Response'
            text/xml:
              schema:
                $ref: '#/components/schemas/Response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
          application/problem+json:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ChangeRxChangePatientRequest'
        description: Patient ID
        required: true
    servers:
    - url: https://virtserver.swaggerhub.com/DoseSpot/dosespot-staging-rest-api-v2/Full_EPCSV2
components:
  schemas:
    Diagnosis:
      type: object
      properties:
        DiagnosisId:
          type: integer
          format: int32
        DiagnosisCode:
          type: string
        DiagnosisDescription:
          type: string
    Result:
      type: object
      required:
      - ResultCode
      properties:
        ResultCode:
          type: string
          description: The result code of the operation.
        ResultDescription:
          type: string
          description: A description of the result, if there were errors.
      description: Represents the result of a service operation.
    DrugUseEvaluation:
      type: object
      properties:
        Reason:
          type: string
        Service:
          type: string
        AckReason:
          type: string
        Result:
          type: string
        Significance:
          type: string
    Patient:
      type: object
      required:
      - Active
      - Address1
      - City
      - DateOfBirth
      - FirstName
      - Gender
      - LastName
      - PrimaryPhone
      - PrimaryPhoneType
      - State
      - ZipCode
      properties:
        PatientId:
          type: integer
          format: int32
        Prefix:
          type: string
          minLength: 0
          maxLength: 10
        FirstName:
          type: string
          minLength: 0
          maxLength: 35
        MiddleName:
          type: string
          minLength: 0
          maxLength: 35
        LastName:
          type: string
          minLength: 0
          maxLength: 35
        Suffix:
          type: string
          minLength: 0
          maxLength: 10
        DateOfBirth:
          type: string
          format: date-time
        Gender:
          type: string
          enum:
          - Male
          - Female
          - Unknown
        Email:
          type: string
          minLength: 0
          maxLength: 80
        Address1:
          type: string
          minLength: 0
          maxLength: 35
        Address2:
          type: string
          minLength: 0
          maxLength: 35
        City:
          type: string
          minLength: 0
          maxLength: 35
        State:
          type: string
          minLength: 0
          maxLength: 50
        ZipCode:
          type: string
          minLength: 0
          maxLength: 10
        PhoneAdditional1:
          type: string
          minLength: 0
          maxLength: 25
        PhoneAdditional2:
          type: string
          minLength: 0
          maxLength: 25
        PhoneAdditionalType1:
          type: string
          enum:
          - Undefined
          - Beeper
          - Cell
          - Fax
          - Home
          - Work
          - Night
          - Primary
        PhoneAdditionalType2:
          type: string
          enum:
          - Undefined
          - Beeper
          - Cell
          - Fax
          - Home
          - Work
          - Night
          - Primary
        PrimaryPhone:
          type: string
          minLength: 0
          maxLength: 25
        PrimaryPhoneType:
          type: string
          enum:
          - Undefined
          - Beeper
          - Cell
          - Fax
          - Home
          - Work
          - Night
          - Primary
        Weight:
          type: number
          format: float
        WeightMetric:
          type: string
          enum:
          - lb
          - kg
        Height:
          type: number
          format: float
        HeightMetric:
          type: string
          enum:
          - inch
          - cm
        NonDoseSpotMedicalRecordNumber:
          type: string
          minLength: 0
          maxLength: 35
        Active:
          type: boolean
        Encounter:
          type: string
          minLength: 0
          maxLength: 50
        IsHospice:
          type: boolean
    PagedListResponse_GetRxChangeDetailedResponse:
      type: object
      properties:
        Items:
          type: array
          description: The list of elements to return.
          readOnly: true
          items:
            $ref: '#/components/schemas/GetRxChangeDetailedResponse'
        PageResult:
          $ref: '#/components/schemas/PageResult'
        Result:
          description: The result of the operation.
          $ref: '#/components/schemas/Result'
    PageResult:
      type: object
      properties:
        CurrentPage:
          type: integer
          format: int32
        TotalPages:
          type: integer
          format: int32
        PageSize:
          type: integer
          format: int32
        TotalCount:
          type: integer
          format: int32
        HasPrevious:
          type: boolean
          readOnly: true
        HasNext:
          type: boolean
          readOnly: true
    ChangeRxChangePatientRequest:
      type: object
      required:
      - PatientId
      properties:
        PatientId:
          type: integer
          format: int32
    CodedPrescriptionRequest:
      type: object
      required:
      - Directions
      - DispensableDrugId
      - DispenseUnitId
      - Quantity
      - Refills
      - Status
      properties:
        DispensableDrugId:
          type: integer
          format: int32
        PatientFormularyId:
          type: integer
          format: int32
        FirstPrescriptionDiagnosis:
          $ref: '#/components/schemas/PrescriptionDiagnosisIds'
        SecondPrescriptionDiagnosis:
          $ref: '#/components/schemas/PrescriptionDiagnosisIds'
        Refills:
          type: integer
          format: int32
          minimum: 0
          maximum: 99
        DaysSupply:
          type: integer
          format: int32
          minimum: 0
          maximum: 365
        DispenseUnitId:
          type: integer
          format: int32
        Quantity:
          type: number
          format: double
        Directions:
          type: string
          minLength: 0
          maxLength: 1000
        PharmacyId:
          type: integer
          format: int32
        PharmacyNotes:
          type: string
          minLength: 0
          maxLength: 210
        NoSubstitutions:
          type: boolean
        EffectiveDate:
          type: string
          format: date-time
        RxReferenceNumber:
          type: string
          minLength: 0
          maxLength: 35
        EligibilityId:
          type: integer
          format: int32
        NonDoseSpotPrescriptionId:
          type: string
          minLength: 0
          maxLength: 35
        IsRefillReplace:
          type: boolean
        IsUrgent:
          type: boolean
        SupervisorId:
          type: integer
          format: int32
        RetailPharmacyToMailToPatient:
          type: boolean
        RTPSCoupon:
          $ref: '#/components/schemas/RTPSCoupon'
        Status:
          type: string
          enum:
          - Unknown
          - Active
          - Inactive
          - Discontinued
          - Deleted
          - Completed
          - CancelRequested
          - CancelPending
          - Cancelled
          - CancelDenied
          - Changed
          - FullFill
          - PartialFill
          - NoFill
        InactiveDate:
          type: string
          format: date-time
        Comment:
          type: string
          minLength: 0
          maxLength: 500
        Encounter:
          type: string
          minLength: 0
          maxLength: 50
    GetRxChangeDetailedResponse:
      type: object
      properties:
        RxChangeRequestId:
          type: integer
          format: int32
        RxChangeType:
          type: string
        RxChangeSubType:
          type: string
        Source:
          type: string
        NewPatient:
          type: boolean
        Patient:
          $ref: '#/components/schemas/Patient'
        UnmatchedChange:
          type: boolean
        PrescribedPrescription:
          $ref: '#/components/schemas/Prescription'
        RequestedMedications:
          type: array
          items:
            $ref: '#/components/schemas/Prescription'
        ClinicianId:
          type: integer
          format: int32
        ClinicId:
          type: integer
          format: int32
        PharmacyId:
          type: integer
          format: int32
        RequestedDate:
          type: string
          format: date-time
        RequestExpirationDate:
          type: string
          format: date-time
        OriginalPrescription:
          $ref: '#/components/schemas/Prescription'
        PayerName:
          type: string
        DrugUseEvaluations:
          type: array
          items:
            $ref: '#/components/schemas/DrugUseEvaluation'
    RTPSCoupon:
      type: object
      properties:
        BIN:
          type: string
        PCN:
          type: string
        MemberID:
          type: string
        GroupID:
          type: string
    PrescriptionDiagnosis:
      type: object
      properties:
        PrimaryDiagnosis:
          $ref: '#/components/schemas/Diagnosis'
        SecondaryDiagnosis:
          $ref: '#/components/schemas/Diagnosis'
    ReconcileRxChangeRequest:
      type: object
      required:
      - ReferencedPrescriptionId
      properties:
        ReferencedPrescriptionId:
          type: integer
          format: int32
          minimum: 1
          maximum: 2147483647
    PagedListResponse_GetRxChangeResponse:
      type: object
      properties:
        Items:
          type: array
          description: The list of elements to return.
          readOnly: true
          items:
            $ref: '#/components/schemas/GetRxChangeResponse'
        PageResult:
          $ref: '#/components/schemas/PageResult'
        Result:
          description: The result of the operation.
          $ref: '#/components/schemas/Result'
    Response:
      type: object
      properties:
        Result:
          description: The result of the operation.
          $ref: '#/components/schemas/Result'
      description: The result of the operation.
    Prescription:
      type: object
      properties:
        FirstPrescriptionDiagnosis:
          $ref: '#/components/schemas/PrescriptionDiagnosis'
        SecondPrescriptionDiagnosis:
          $ref: '#/components/schemas/PrescriptionDiagnosis'
        Refills:
          type: string
        PrescriptionId:
          type: integer
          format: int32
        WrittenDate:
          type: string
          format: date-time
        Directions:
          type: string
        Quantity:
          type: string
        DispenseUnitId:
          type: integer
          format: int32
        DaysSupply:
          type: integer
          format: int32
        PharmacyId:
          type: integer
          format: int32
        PharmacyNotes:
          type: string
        NoSubstitutions:
          type: boolean
        EffectiveDate:
          type: string
          format: date-time
        LastFillDate:
          type: string
          format: date-time
        PrescriberId:
          type: integer
          format: int32
        PrescriberAgentId:
          type: integer
          format: int32
        RxReferenceNumber:
          type: string
        Status:
          type: string
          enum:
          - Unknown
          - Entered
          - Printed
          - Sending
          - eRxSent
          - FaxSent
          - Error
          - Deleted
          - Requested
          - Edited
          - EpcsError
          - EpcsSigned
          - ReadyToSign
          - PharmacyVerified
          - PharmacySelect
        Formulary:
          type: boolean
        EligibilityId:
          type: integer
          format: int32
        Type:
          type: string
          enum:
          - Coded
          - FreeText
          - NDC
          - Supply
          - Compound
        NonDoseSpotPrescriptionId:
          type: string
        ErrorIgnored:
          type: boolean
        SupplyId:
          type: integer
          format: int32
        FreeTextType:
          type: string
          enum:
          - Medication
          - Supply
          - Compound
        ClinicId:
          type: integer
          format: int32
        SupervisorId:
          type: integer
          format: int32
        IsUrgent:
          type: boolean
        IsRxRenewal:
          type: boolean
        RxRenewalNote:
          type: string
        Strength:
          type: string
        PatientMedicationId:
          type: integer
          format: int32
        MedicationStatus:
          type: string
          enum:
          - Unknown
          - Active
          - Inactive
          - Discontinued
          - Deleted
          - Completed
          - CancelRequested
          - CancelPending
          - Cancelled
          - CancelDenied
          - Changed
          - FullFill
          - PartialFill
          - NoFill
        Comment:
          type: string
        DateInactive:
          type: string
          format: date-time
        Encounter:
          type: string
        DisplayName:
          type: string
        DispensableDrugId:
          type: integer
          format: int32
        Schedule:
          type: integer
          format: int32
        CompoundIngredients:
          type: array
          items:
            $ref: '#/components/schemas/CompoundIngredient'
    DenyRxChangeRequest:
      type: object
      required:
      - Reason
      properties:
        Reason:
          type: string
          enum:
          - DeniedPatientUnknown
          - DeniedPatientNotUnderCare
          - DeniedPatientNoLongerUnderPatientCare
          - DeniedNeverPrescribed
          - DeniedHavePatientContact
          - DeniedChangeInappropriate
          - DeniedNeedAppointment
          - DeniedPrescriberNotAssociateWithLocation
          - DeniedNoPriorAuthAttempt
          - DeniedAlreadyHandled
          - DeniedAtPatientRequest
          - DeniedPriorAuthNoAttempt
          - DeniedPriorAuthInProgress
          - DeniedOrderNotFound
          - DeniedPayerNoPriorAuth
          - DeniedPatientNoRecord
          - DeniedOrderExpired
          - DeniedPharmacyNotRecognized
        Comment:
          type: string
          minLength: 0
          maxLength: 70
    GetRxChangeResponse:
      type: object
      properties:
        RxChangeRequestId:
          type: integer
          format: int32
        RxChangeType:
          type: string
        RxChangeSubType:
          type: string
        Source:
          type: string
        NewPatient:
          type: boolean
        Patient:
          $ref: '#/components/schemas/Patient'
        UnmatchedChange:
          type: boolean
        PrescribedPrescriptionId:
          type: integer
          format: int32
        RequestedMedications:
          type: array
          items:
            type: integer
            format: int32
        ClinicianId:
          type: integer
          format: int32
        ClinicId:
          type: integer
          format: int32
        PharmacyId:
          type: integer
          format: int32
        RequestedDate:
          type: string
          format: date-time
        RequestExpirationDate:
          type: string
          format: date-time
        OriginalPrescriptionId:
          type: integer
          format: int32
        PayerName:
          type: string
        DrugUseEvaluations:
          type: array
          items:
            $ref: '#/components/schemas/DrugUseEvaluation'
    ApproveRxChangeRequest:
      type: object
      properties:
        PriorAuthNumber:
          type: string
        SelectedMedicationId:
          type: integer
          format: int32
        NewPrescriptionPatientId:
          type: integer
          format: int32
        NewPrescription:
          $ref: '#/components/schemas/CodedPrescriptionRequest'
        Comment:
          type: string
          minLength: 0
          maxLength: 500
        PrescriberAuthorizationData:
          type: string
          minLength: 0
          maxLength: 32
        PrescriberLicenseInactive:
          type: boolean
    IdentifierResponse:
      type: object
      properties:
        Id:
          type: integer
          format: int32
          description: The entity identifier.
        Result:
          description: The result of the operation.
          $ref: '#/components/schemas/Result'
      description: Represents a generic response containing an entity identifier.
    CompoundIngredient:
      type: object
      required:
      - Quantity
      properties:
        DispensableDrugId:
          type: integer
          format: int32
        FreeText:
          type: string
        DispenseUnitId:
          type: integer
          format: int32
        Quantity:
          type: string
        IsFreeTextEPCS:
          type: boolean
    PrescriptionDiagnosisIds:
      type: object
      properties:
        PrimaryDiagnosisId:
          type: integer
          format: int32
        SecondaryDiagnosisId:
          type: integer
          format: int32
x-refined-from:
- dosespot-rest-api-full-epcs-v2-swagger.json
- dosespot-rest-api-jumpstart-epcs-v2-swagger.json