Pharmacy Re-Engineering (pre) Application Program Interface (api) Manual

Component: GET1

This API accepts input values and returns a single field from either the PRESCRIPTION file (#52) or its sub-files as defined by the VA FileMan DBS call $$GET1^DIQ.

S X=$$GET1^PSODI(PSOFILE,PSOIEN,PSOFIELD,PSOFLAGS,PSOWORD)

Input:

PSOFILE

PSOFIELD

PSOWORD

PSOFILE = File or sub-file number [REQUIRED]

processing fields

Output:

$$GET1

Returned field will be in the format “1^(field)”. See VA FileMan

Programmer Manual V 22.0 for $$GET1^DIQ output definition

Component: STATUS

This API will accept input values and return the specified field-attribute “POINTER” as defined by VA FileMan Data Retrieval call FIELD^DID. This API is restricted to only the STATUS field (#100) of the PRESCRIPTION file (#52).

STATUS^PSODI(PSOFILE,PSOFIELD,LIST)

Input:

PSOFILE

LIST

PSOFILE = File number used for validation of access [required]

PSOFIELD = Field number from the specified file associated with the value in PSOFILE [required]

LIST = Array name defined by the calling application [required]

Output:

PSODIY will return null if the value for PSOFILE is valid (it will return -1 if conditions were not met)

See VA FileMan Programmer Manual for FIELD^DID output definition

Note: Make sure LIST("POINTER") is not defined when making this call.

PSOORDER API – PRESCRIPTION file (#52)

Component: EN

Open subscription for Outpatient Pharmacy prescription data.

EN^PSOORDER(DFN,RX#)

Input:

DFN

Where:

If the patient’s IEN is not sent; then a null value must be

RX# = IEN of a prescription. The IEN is obtained from either the PRESCRIPTION PROFILE MULTIPLE file (#52) in the

Note: Requires version 7.0 of Outpatient Pharmacy software to be installed.

Output:

^TMP("PSOR",$J,RXN,0) = ID^FD^LSFD^ST^RX#^QTY^DS^RF^RFM^DRCT^

Where:

ID = Issue date of Rx

FD = Fill date of Rx

LSFD = Last fill date of Rx

ST = Status of Rx; variable has format A;B where:
A = code

B = external printable form, (e.g., A for ACTIVE, DC for

If the status of a prescription = Hold:

^TMP("PSOR",$J,RXN,"HOLD",0) = HDRS^HDCOM^HDDT

Where:

HDRS = Hold Reason

HDDT = Hold Date

If the status of a prescription = Suspended or has had an entry in the RX SUSPENSE file (#52.5)

Output:

Where:

CMIND = CMOP Indicator; where:

Note: Data only appears in this field if sites have the CMOP package installed and implemented.

RX# = External Rx number

QTY = Quantity Dispensed

DS = Day Supply

RF = Number of refills

RFM = Number of refills remaining

DRCT = Drug Cost of Original Fill

RXCT = Rx Cost of Original Fill

EXDT = Expiration/Cancel date of Rx

RELDT = Release Date/Time

RTSDT = Returned to Stock Date

WPC = Was Patient Counseled (Yes/No)

PAT = Patient; variable format A;B where:

LDT = This date is the date the original Rx was added to the prescription file (#52). Login Date.

Output:

^TMP("PSOR",$J,RXN,1) = PR^CLK^VRP^CLN^RXP^MW^DIV^OERR#^FP^NDC^TPBRX

PR = Provider, variable format A;B where:

CLK = Entered By (clerk code); variable format A;B where:

VRP = Verifying Pharmacist; variable format A;B where:

CLN = Clinic; variable format A;B where:

FP = Finishing Person. This variable has the format A;B

NDC = National Drug Code.

TPBRX = This variable indicates that the Rx has been created as part of the Transitional Pharmacy Benefit project.

CMOP Data: If applicable:

Output:

^TMP("PSOR",$J,RXN,"CMOP",n,0) = TRANS #^SEQ#^FILL#^CMSTA^CMDCDT^NDC

TRANS # = Transaction number; points to the CMOP TRANSMISSION file (#550.2)

SEQ # = Sequence number; represents order number sent to the CMOP
host facility

Fill # = Fill #; where:

CMSTA = CMOP Status; variable format A;B where:

CMDCDT = CMOP cancel date

NDC = National Drug File Code - free text

Output:

Where:

Drug Data:

Output:

^TMP("PSOR",$J,RXN,"DRUG",0) = DR^VA PRINT NAME^DRUGID^VA DRUG CLASS

DR = Drug in Rx; variable format A;B where:

VA Print Name = VA Print name found in the VA PRODUCT file (#50.68)

DRUGID = CMOP ID (VA PRODUCT IDENTIFIER) found in the VA PRODUCT file (#50.68)

VA DRUG CLASS = VA DRUG CLASSIFICATION

Output:

^TMP("PSOR",$J,RXN,"DRUGOI",0) = ORDERABLE ITEM

ORDERABLE ITEM = Pharmacy Orderable Item tied to the drug in the Rx; variable format A;B where:

Copay: If applicable

Output:

^TMP("PSOR",$J,RXN,"IB",0) = COPAY TRANSACTION TYPE^IB NUMBER

COPAY TRANSACTION TYPE = 1 or 2

IB NUMBER = pointer to the INTEGRATED BILLING ACTION file (#350)

Refills:

^TMP("PSOR",$J,RXN,"REF",n,0) = RFD^PR^CLK^QTY^DS^DRCT^RXCT^RELDT^RTSDT^M/W^DIV^LDT^NDC

Where:

RXN = Internal Rx #

PR = Provider; variable format A;B where:

A = internal pointer and
B = external printable form

CLK = Refill entry by; variable format A;B where:

QTY = Quantity Dispensed

DS = Day Supply

DRCT = Drug Cost of Refill

RXCT = Rx Cost of Refill

RELDT = Release Date/Time

RTSDT = Returned to Stock Date

M/W = Mail/Window Routing; variable format A;B where:

DIV = pointer to the OUTPATIENT SITE file (#59)

LDT = This date indicates the date the refill was requested. This is not the date the refill will be dispensed (Login Date)

NDC = National Drug Code

Partial Fills:

Output:

Where:

PRD = Partial Date

PR = Provider; Variable format A;B where:
A = internal pointer and
B = external printable form

CLK = Refill entry by; variable format A;B where:

A = internal pointer and
B = external printable form

QTY = Quantity Dispensed

DS = Day Supply

DRCT = Drug Cost of partial fill

RXCT = Rx Cost of partial fill

RELDT = Release Date/Time

RTSDT = Returned to Stock Date

M/W = Mail/Window Routing; variable format A;B where:

LDT = This date indicates the date the partial fill was created(Login Date)

NDC = National Drug Code

Activity Log:

Output:

^TMP("PSOR",$J,RXN,"ACT",n,0) = D/T^REA^NEW PERSON^RX #^COMMENTS

D/T = Date/Time entry made

REA = Reason entry was made

NEW PERSON = Entry created by

NEW PERSON = Entry created by; variable format A;B where:
A = internal pointer and
B = external printable form

RX # = which fill the activity occurred on (original, refill, or partial)

COMMENTS = Comments about the activity that occurred

Medication Instructions:

Output:

^TMP("PSOR",$J,RXN,"SIG",n,0) = Condensed Medication Instructions (SIG)

Dispensing Instructions:

Output:

^TMP("PSOR",$J,RXN,"MI",N,0) = DOSAGE^DOSE^UNITS^NOUN^DURATION^CONJUNCTION^MRT^SCH^VERB

DOSAGE = This is the strength of the medication dispensed. This variable can be a numeric value or free-text

DOSE = This numeric value represents the total number of pills to make a total dosage. This value is only returned when the dosage is numeric

UNITS = This data element is the unit of measure the medication is dispense. This variable has the format A;B where:

A is the internal pointer

B is external printable form

NOUN = This data element indicates the form the medication was dispensed, i.e., tablet

DURATION = This indicates how long this dosage should be taken

CONJUNCTION = This data element is used for complex dosing instructions

MRT = This data element indicates how the medication is ingested (medication route). This variable has the format A;B where:

A is the internal pointer and

B is external printable form

SCH = This data indicates when the medication is taken (schedule)

VERB = This data element indicates what action is taken to ingest the medication

Patient Instructions:

Output: ^TMP("PSOR",$J,RXN,"PI",n,0) = EXPANDED PATIENT INSTRUCTIONS