Script / RxTransfer Fields

📃
Note:
An empty string "" is considered a value and validation rules will apply (length/valid code/etc). Only null or missing elements will use default values.

Script Request

Field	Type	Character Limit	Required/Optional	Description
scriptKey	String	50	Required	Unique ID assigned by sending pharmacy to each prescription transfer request for tracking.
sendingPharmacy	Object		Required	Contains information about the pharmacy transferring the prescription - see Pharmacy table.
receivingPharmacy	Object		Required	Contains information about the pharmacy the prescription is being transferred to - see Pharmacy table.
patientKey	String	30	Required	Unique patient ID in Client system. This key will be sent on the order status message. The patientKey must be unique and patient must exist in the system when sending Transfer Request.
prescription	Object		Required	Contains the prescription information. See Prescription table.
transferFileType	String	xml/png	Required	The file type for the transfer file. Acceptable values are xml and png.
transferFileUrl	urlSafeBase64	2048	Required	Base 64 encoded URL where the XML or PNG transfer file can be downloaded from.
orTransfer	Boolean	true/false	Required	If this is a prescription transfer the value is true, for triage the value is false

Pharmacy

Field	Type	Character Limit	Required/Optional	Description
pharmacyName	String	70	Required	Name of the pharmacy
pharmacyNpi	String	15	Required	Pharmacy NPI ID
pharmacyNcPdp	String	15	Optional	Pharmacy NCPDP ID
deaNumber	String	15	Optional	Pharmacy DEA number
phone	String	10	Required	Pharmacy Phone number
fax	String	10	Optional	Pharmacy Fax number
pharmacist	Object		Required	Object containing information on the pharmacist. See Pharmacist table.
contact	Object		Required	Object containing contact information for the pharmacist. See Contact table.
address	Object		Required	Object containing the pharmacy address information. See Address table.

Pharmacist

Field	Type	Character Limit	Required/Optional	Description
firstName	String	35	Required	First Name of pharmacist.
lastName	String	35	Required	Last Name of pharmacist.

Contact

Field	Type	Character Limit	Required/Optional	Description
contactType	String	15	Optional	Patient Contact – Phone, Home Phone, Day Phone, Work Phone, Fax Number, Cellular Number, Alternate
contactAddress	String	10	Required	Contact Details. For instance: Populate phone number if contact type is phone. Format:XXXXXXXXXX

Address

Field	Type	Character Limit	Required/Optional	Description
line1	String	40	Required	Street Address
line2	String	40	Optional	Street Address
city	String	20	Required	City
state	String	2	Required	US State Abbreviation Code
zipCode	String	5	Required	Format NNNNN

Prescription

Field	Type	Character Limit	Required/Optional	Description
prescriber	Object		Required	Object containing prescriber information. See Prescriber table.
rxNumber	String	12	Required	Rx number of the prescription as per client's system.
prescribedDrugName	String	60	Required	Name of the medication as prescribed by the prescriber.
prescribedNdc	String	11	Required	NDC prescribed by the prescriber.
dispenseNdc	String	11	Required	NDC dispensed by the pharmacy.
dispenseDrugName	String	60	Required	Name of the medication to be dispensed.
drugDosageForm	String	30	Required	Dosage form for the dispensed medication. For example: TABS,SWAB,CHEW etc.
drugStrength	String	15	Required	Medication Strength corresponding to dispensed drug as prescribed by provider.
daysSupply	Int32		Required	Number of days the medication covers as prescribed by the provider.
quantityWritten	Double		Required	Total Quantity (in Metric units) as prescribed by the provider.
firstFillDispensedQuantity	Double		Required	Quantity (in Metric units) that has been dispensed by the pharmacy in the first fill. Populate 0 if the transferring pharmacy has not dispensed any medication for the Rx.
quantityDispensedToDate	Double		Required	Quantity (in Metric units) that has been dispensed by the pharmacy till Date. Populate 0 if the transferring pharmacy has not dispensed any medication for the Rx.
remainingQuantity	Double		Required	Quantity (in Metric units) that is yet to be dispensed. It must be equal to quantityWritten - quantityDispensedtoDate.
labelDirections	String	200	Required	Prescription usage instructions. Also commonly referred to as the Instructions/Signature. This must be populated in English language and must not contain following characters: \| (Pipe), ^ (component separator), ~ (field repetition separator), (escape character), & (Sub-component separator)
writtenDate	Date-time	YYYY-MM-DD	Required	Written date of the prescription; Format YYYYMMDD.
expirationDate	Date-time	YYYY-MM-DD	Required	Prescription’s expiration date; Format YYYYMMDD.
dawCode	String	1	Required	DAW code as prescriber by prescriber.
refillsAuthorized	String	2	Required	Counts of refills authorized by prescriber. If the prescriber authorized 4 refills, populate 4
lastFillDate	Date-time	YYYY-MM-DD	Optional	Date when last fill occurred. Format YYYY-MM-DD. Must populate for Transfer. If the transfer pharmacy has not fulfilled any order yet, then populate NULL.
firstFillDate	Date-time	YYYY-MM-DD	Optional	Date when first fill occurred. Format YYYY-MM-DD.Must populate for Transfer. If the transfer pharmacy has not fulfilled any order yet, then populate NULL.
fillsToDate	Int32		Required	Total number of fills fulfilled for the Rx till Date. If the transfer pharmacy has not fulfilled any order yet, then populate 0. If the provider authorized 4 refills and 2 fills have been fulfilled, then populate 2
refillsLeft	Int32		Required	Total number of fills remaining. Should be equal to fillsAuthorized -fillsToDate.
refillsTransferred	Int32		Required	Number of refills being transferred to HD for fulfillment. If the provider authorized 4 refills and 2 fills have been fulfilled, then populate 3
currentFillNumber	String	2	Required	Populate the current fill number. If there is no order fulfilled yet, populate 00. If the provider authorized 4 refills and 2 fills have been fulfilled, then populate 02

Prescriber

Field	Type	Character Limit	Required/Optional	Description
firstName	String	35	Required	Prescriber (Doctor's) First Name
lastName	String	35	Required	Prescriber (Doctor's) Last Name
npi	String	15	Required	Prescriber's NPI ID
dea	String	15	Optional	Prescriber's DEA number
phoneNumber	String	10	Required	Prescriber's phone number
phoneNumberExtension	String	8	Optional	Prescriber's phone extension
faxNumber	String	10	Required	Prescriber's fax number
address	Object		Required	Prescriber's address information. See Address table.

Updated 2 months ago