Patches a patient order's information for a given patient order ID.

patch

https://integrationhub.wellsky.io/commands/v4/patientorders/drug/injpo

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

The request containing the patient order information.

The information used to create or update Patient Orders with INJ/PO Rx type.

patientOrderId

int64 | null

Unique Identifier of the patient order id. If provided, the order will be updated; otherwise, a new order will be created.

name

string | null

Name of the Patient Order
To clear the Name, send an empty string "".

description

string | null

Description of the Patient Order
To clear the Description, send an empty string "".

dispenseInventoryItemId

int64 | null

Unique identifier of the dispense/inventory item.

strength

string | null

Strength/dose of the medication.
To clear the Strength, send an empty string "".

unitOfMeasure

string | null

User defined look up value for unit of measure.
To clear the Unit of Measure, send an empty string "".

hcpc

string | null

User defined look up value for HCPC code.
To clear the HCPC, send an empty string "".

prescriptionFormat

string | null

User defined look up value for prescription format.
To clear the Prescription Format, send an empty string "".

orderedDate

date-time | null

Date of the patient order.
To clear the Ordered date, send DateTime.MinValue (0001-01-01T00:00:00Z).

startDate

date-time | null

Start date of the patient order.
To clear the start date, send DateTime.MinValue (0001-01-01T00:00:00Z).

stopDate

date-time | null

Stop date of the patient order.
To clear the Stop date, send DateTime.MinValue (0001-01-01T00:00:00Z).

discontinuedDate

date-time | null

Date the order was discontinued.
To clear the Discontinued date, send DateTime.MinValue (0001-01-01T00:00:00Z).

therapyType

string | null

User defined look up value for therapy type.

patientOrderStatus

string | null

Look up value for patient order status.

comments

string | null

To clear the Comments, send an empty string "".

isStatOrder

boolean | null

Flag for stat order.

statOrderChangeReason

string | null

Change reason for stat order.

isAuthorizationRequired

boolean | null

Flag for requires auth.

isRxPresent

boolean | null

Flag for Rx present.

companyId

int64 | null

Unique identifier of the company.
Kept company id as optional as we can set patient's company as default for patient order.

billingProviderId

int64 | null

Unique identifier of the billing provider.

team

string | null

User defined lookup value for team.
To clear the Team, send an empty string "".

referralSourceId

int64 | null

Unique identifier of the referral source.
To clear the referral source, send 0.

salesRepId

int64 | null

Unique identifier of the sales representative.
To clear the sales representative, send 0.

prescriberId

int64 | null

Unique identifier of the prescriber.

authorizationOverrideType

string | null

Lookup value for authorization override type.

billingAuthorizationId

int64 | null

Unique identifier of the billing authorization.
To clear the billing authorization, send 0.

isBilledForDenial

boolean | null

Flag for billed for denial.

isTherigySTMRequestSent

boolean | null

Flag for Is Therigy STM Request Sent.

isSendToCAPS

boolean | null

Flag for Is Send to CAPS.

primaryPayerPolicyNumber

string | null

Primary payer policy number of the patient.
Updates payer policy associations for a PatientOrder based on PolicyNumber and GroupNumber matching.
Matching Priority: 1) PolicyNumber + GroupNumber, 2) PolicyNumber only, 3) No update if no match.
To clear the Primary payer policy number, send an empty string "", But Patient(self-pay) will be assigned as Primary Payer.

primaryPayerGroupNumber

string | null

Primary payer group number of the patient.
To clear the Primary payer Group number, send an empty string ""

secondaryPayerPolicyNumber

string | null

Secondary payer policy number of the patient.
Updates payer policy associations for a PatientOrder based on PolicyNumber and GroupNumber matching.
Matching Priority: 1) PolicyNumber + GroupNumber, 2) PolicyNumber only, 3) No update if no match.
To clear the Secondary payer policy number, send an empty string ""

secondaryPayerGroupNumber

string | null

Secondary payer group number of the patient.
To clear the Secondary payer group number, send an empty string ""

perDiemOrSupplyPayerPolicyNumber

string | null

Per Diem/ Supply payer policy number of the patient.
Updates payer policy associations for a PatientOrder based on PolicyNumber and GroupNumber matching.
Matching Priority: 1) PolicyNumber + GroupNumber, 2) PolicyNumber only, 3) No update if no match.
To clear the Per Diem/ Supply payer policy number, send an empty string ""

perDiemOrSupplyPayerGroupNumber

string | null

Per Diem/ Supply payer group number of the patient.
To clear the Per Diem/ Supply payer group number, send an empty string ""

denialPayerPolicyNumber

string | null

Denial payer policy number of the patient.
Updates payer policy associations for a PatientOrder based on PolicyNumber and GroupNumber matching.
Matching Priority: 1) PolicyNumber + GroupNumber, 2) PolicyNumber only, 3) No update if no match.
To clear the Denial payer policy number, send 0.

denialPayerGroupNumber

string | null

Denial group number of the patient.
To clear the Denial group number, send 0.

writtenInventoryItemId

int64 | null

Unique identifier of the written/inventory item.

frequency

string | null

User defined look up value for frequency.
To clear the Frequency, send an empty string "".

frequencyInterval

string | null

User defined look up value for frequency interval.
To clear the Frequency Interval, send an empty string "".

route

string | null

User defined look up value for drug route.
To clear the Route, send an empty string "".

duration

string | null

Duration of the medication order.
To clear the Duration, send an empty string "".

infusionDuration

double | null

≥ 0

Duration of drug infusion in minutes/hours.
To clear the Infusion Duration, send 0.

infusionPeriod

string | null

User defined look up value for infusion period.
To clear the Infusion Period, send an empty string "".

method

string | null

User defined look up value for pump type.
To clear the Method, send an empty string "".

catheterType

string | null

User defined look up value for catheter type.
To clear the Catheter Type, send an empty string "".

daw

string | null

User defined look up value for prescription dispense constraint.
To clear the DAW, send an empty string "".

patientOrderDrugFillType

string | null

User defined look up value for patient order drug fill type.
To clear the patient order drug fill type, send an empty string "".

therapyClass

string | null

Therapy class of the drug.
To clear the Therapy Class, send an empty string "".

medicationProfileClass

string | null

User defined look up value for medication profile class.
To clear the Medication Profile Class, send an empty string "".

isPrimaryOrder

boolean

User defined look up value for patient order drug fill type.
Equivalent to Primary or Ancillary checkbox under the Rx info of add drug order window UI screen.

isSpecialtyRx

boolean

Flag for Specialty Rx.

isQuickFill

boolean

Flag for Quick fill.

isComplex

boolean | null

Flag indicating if the order is complex.

isMedicareDocumentationRequired

boolean | null

Flag indicating if Medicare documentation is required.

usePerDiemKitRule

boolean

Flag for use per diem/kit rule.

perDiemItemId

int64 | null

Unique identifier of the per diem item.
To clear the per diem item, send 0.

associatedOrderId

int64 | null

Unique identifier of the associated patient order.
To clear the associated patient order, send 0.

assignPatientDiagnosisToOrder

boolean

Flag to assign patient diagnosis to order.

shpInformation

object

SHP information for patient drug orders.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

403Forbidden

404Not Found

500Internal Server Error