Note: This proprietary format for submitting electronic orders is provided for the use of laboratories licensed to use Rx-Universe only. It cannot be shared with outside companies or sources without prior, written consent from Optical Laboratory Software Solutions.
Overview:
The Remote Order Entry process allows a third-party program to create an ASCII file for Rx-Universe, containing information necessary to order an Rx from the lab. This file uses the VCA convention for data transfers, with additional labels defined by Rx-Universe for fields not directly supported by the VCA device standard. These additional labels will have a suffix of an underscore “_”; for example “_FIRSTNAME”.
...
This document will explain what codes you need to send to Rx-Universe, the format in which the request/orders will need to be sent to Rx-Universe and how to interpret the information that Rx-Universe sends back.
Figure 1-1
Rx-Universe Inbox (for incoming orders into the lab)
Information (RAW files) coming from the retail site will be stored in a folder determined by the lab which is located on the lab’s server. The most common method of file transfer from a retail site to the lab is via ftp, where the default folder for the ftp transfer will point to the appropriate folder. By default the folder is “OMICSTX” a subfolder of the “RXUNIVERSE” folder on the lab’s server. For example “C:\RXUNIVERSE\OMICSTX”.
Rx-Universe Outbox (for outgoing status results)
Information that is sent back from Rx-Universe will be located in this directory, which is usually called “OMICSRX” – this is usually a subfolder below the default “RXUNIVERSE” folder on the lab’s server. For example “C:\RXUNIVERSE\OMICSRX”. Under this folder there is a folder for each customer created by Rx-Universe automatically, the folder name will be the account number, this is where the retail site will have to pick up the status files.
- For example “C:\RXUNIVERSE\OMICSRX\account_number”:
- “C:\RXUNIVERSE\OMICSRX\1” (status files for account 1)
- “C:\RXUNIVERSE\OMICSRX\0025” (status files for account 0025)
- “C:\RXUNIVERSE\OMICSRX\1234” (status files for account 1234)
Naming Conventions
There are naming conventions that are used for every document Rx-Universe either sends or receives and the directories they are stored in. Each of these naming conventions will be explained as we get into detail about each document.
Sending Orders To Rx-Universe
File Name:
The naming convention that is used for the order file is very important. The retailer will need to get their account number from the lab and store it somewhere in their system, since it is used in the flat file (RAW File) name.
The format of the file name is Account Number.V + sequence number (2 to 4 digits)
...
A complete order file will consists of many fields, with corresponding values. A list of fields is given; following the list is an example of a complete order submission.
General Information
Required column - O=optional, R=required
Chiral column - N=non-chiral (one value per label); Y=chiral (value is right, semi-colon, left - ie 2.50;1.25)
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|---|---|
_CUSTNO | O | N | String | 09 | Account Number | |
JOB | R | N | String | 21 | Job number from retail | This information is saved in the “PO#” field. |
_INV | O | N | String | 08 | Invoice number | Use this field if you want to keep the same Invoice Number as |
_OMICS_TRAY_NUM | O | N | String | 06 | Tray Number | Use this field if you want to keep the same Tray Number as |
_JTYPE | R | N | String | 01 | Job Type | Valid Values: |
PATIENT | R | N | String | 21 | Patient Name | This field is not needed if you are using the “_FIRSTNAME” and |
_FIRSTNAME | R | N | String | 21 | First name of patient | Use either PATIENT or combination of first and last name |
_LASTNAME | R | N | String | 21 | Last name of patient | Use either PATIENT or combination of first and last name |
_RDATE | O | N | String | 08 | Date Ordered | YYYYMMDD |
_WDATE | O | N | String | 08 | Date Wanted | YYYYMMDD |
_OPT_WDATE | O | N | String | 8 | Optional date wanted | YYYYMMDD |
REF | O | N | String | 18 | Release Number | |
SHIPTO | O | N | String | 10 | Ship to Number | Each part separated by a comma. |
REM | O | N | String | 30 | Remarks or Special Instructions. | Can have up to 11 comment lines. |
_CALLFST
| O | N | String | 01 | Call first before processing. | Valid Entries are: |
_REMAKECODE | O | N | String | 04 | Remake code | An entry in this field sets the REDO flag on the order and |
_RUSH_JOB | O | N | String | 01 | Set Rush indicator on order | Valid Entries are: |
_DOCTOR_ID | O | N | String | 30 | Doctor’s name | |
_ORD-ORIG_INVOICE | O | N | String | 08 | Used to send the original invoice number when sending a remake job | |
_REMAKE_CAT | O | N | String | 04 | Used to send the remake category | |
_PRLIST | O | N | String | 03 | Price list number. | Specify to force pricing to a certain lab price list. |
_TRAY_COLOR | O | N | String | 03 | Used to override the tray color that would normally be associated | |
_LAYOUT | O | N | String | 01 | Indicates whether frame measurements should be considered exact, | Valid Entries are: |
_UNCUTDIAM | O | Y | Numeric | 05 | Diameter to use for thickness for uncut job | Value >= 0 and <= 99.9 |
_USER_DEF_JF | C | N | String | 10 | User Define Job Flow Labels. |
Rx And Lens Information
Field Name | Reqd | Chiral | Data Type | Length | Description | Format / Valid Values | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
DO | R | Y | String | 01 | Which eye | Valid Values: | ||||||
_LSTYLE | C | Y | String | 06 | If _LCODE and UPC are not specified, this field specifies the lab code for the lens style being ordered | |||||||
_MATERIAL | C | Y | String | 02 | If _LCODE and UPC are not specified, this field specifies the lab code for the lens material being ordered | |||||||
_TREAT | C | Y | String | 03 | If _LCODE and UPC are not specified, this field specifies the lab code for the treatment of the lens | This is the Pretreatment that comes already on the lens from the manufacturer. | ||||||
_TINT | C | Y | String | 03 | If _LCODE and UPC are not specified, this field specifies the lab code for the tint of the lens | This is the Tint (Color) that comes already on the lens from the manufacturer | ||||||
_LCODE | C | Y | String | 02 | Lens Material | Refer to catalogue reference, under the lens section. This is the code from the catalogue You may also use UPC with the UPC translation table to specify materials, lens styles, | ||||||
SPH +/- | R | Y | Numeric | 05 | Rx Sphere Power | Range from -39.0 to +49.0 and must be a multiple of 0.125, rounded to 2 | ||||||
CYL +/- | O | Y | Numeric | 05 | Rx Cylinder Power | Valid values range from-19.75 to +19.75, in increments of 0.125, rounded to | ||||||
AX | C | Y | Integer | 03 | Prescribed Cylinder Axis. | Valid values range from 0 to 180. | ||||||
IPD | R | Y | Numeric | 03 | Far PD: The far interpupillary distance for Multifocals and can be entered as | Valid range values: | ||||||
NPD | C | Y | Numeric | 03 | Near PD or Vertical Decentration: | Valid range values: For SV-Style lenses, this field represents the distance above or below the datum of the OC. | ||||||
OCHT | O | Y | Numeric | 04 | Vertical O.C. height measured from the lower boxes tangent of the frame. | |||||||
ADD | C | Y | Numeric | 04 | The add power of the multifocal segment; required for multifocal lenses | 99.99 | ||||||
ADD2 | C | Y | Numeric | 04 | The add power of the upper segment in an occupational lens | 99.99 | ||||||
SEGHT | C | Y | Numeric | 03 | Segment Height | Ex: SEGHT=19;19 | ||||||
PRVM +/- | O | Y | Numeric | 04 | Rx Prism in diopters | Ex: | ||||||
PRVA | C | Y | String | 03 | Rx Prism direction | Ex: | ||||||
ELLH | O | Y | Numeric | 02 | Elliptical Cribbing | Ex: ELLH=62;62 | ||||||
_SUPELLH | O | Y | String | 01 | Suppress Elliptical Cribbing | Valid Values are: | ||||||
THNP | O | Y | Numeric | 03 | Requested edge thickness at the thinnest edge | Ex: THNP=1.5;1.5 | ||||||
_PRTHIN | O | N | String | 01 | Prism Thinning | Valid Entries Are: | ||||||
_ADDON | O | N | String | 06 | Add-on Codes | Codes specified by receiving lab or from catalogue. | ||||||
CLASS | O | Y | String String | 03 03 | To force Finished (Stock) or Semi-Finish lenses per eye | Valid Values | ||||||
_FORCESF_F | O | Y | String | 01 | To force Semi-Finish or Finished (Stock) lenses on your job | Valid Values: | ||||||
_RFRONT | O | Y | String | 04 | Requested Nominal Front Curve | Ex: _RFRONT=0400;0400 | ||||||
_RDIA | O | Y | Numeric | 02 | Requested Blank (Lens) Diameter | Ex: _RDIA=76;76 | ||||||
_LMFRID | O | Y | String | 04 | Lens Manufacturer | If you want to force Rx-Universe to select a lens from a certain manufacturer | ||||||
OPC | O | Y | Numeric | 10 | Lens OPC Code | Select lenses by OPC codes | ||||||
SWIDTH | C | Y | Numeric | 02 | Segment Width | Ex:_SWIDTH=28;28 | ||||||
SDEPTH | C | Y | Numeric | 02 | Segment Depth of the Intermediate Segment. Required only for Trifocal lenses | Ex:SDEPTH=08;08 | ||||||
LNAM | O | Y | String | 23 | VCA Label Translation | |||||||
LTYP | O | Y | String | 23 | VCA Label Translation | LMATTYPE | O | Y | String | 23 | VCA Label Translation | |
HBOX | C | O | Numeric | 03 | Horizontal box lens size of the frame. This is the “A” measurement | Valid range of values is from 30.0 to 80.0 mm | ||||||
VBOX | C | O | Numeric | 03 | Vertical boxes lens size of the frame. This is the “B” measurement. | Valid range of values is from 15.0 to 60.0 mm | ||||||
_EDBOX | C | O | Numeric | 03 | “ED” measurement of the box measurement system. The widest possible | Valid range of values is from 30.0 to 80.0 mm | ||||||
DBL | R | N | Numeric | 03 | Distance Between Lenses | Valid range of values is from 7.0 to 30.0 mm | ||||||
ETYP | O | N | String | 01 | Type of edge to cut on lens. | Valid Entries are: | ||||||
SFTHK | O | N | String | 01 | This field needs to be placed after the “ETYP” field | Y = Safety Thickness | ||||||
FTYP | O | N | StringNumeric | 01 | Frame Type | Valid Entries are: | ||||||
_TRACE | O | N | String | 12 | Trace Number | Rx-Universe will look into the Pattern Database for a Frame Name matching | ||||||
_CCIRC | O | N | Numeric | 04 | You can specify the actual circumference of the customer’s frame. | Ex: CIRC=138.4 | ||||||
_WRAP | O | N | String | 01 | To take advantage of the Wrap Frame Calculation. | Valid Entries are: | ||||||
ZTILT | O | N | Numeric | 03 | Panoramic (Wrap) Angle | Valid range of values is from 0 to 30.0 degrees | ||||||
PANTO | O | N | Numeric | 03 | Pantoscopic (Angle) Tilt | Valid range of values is from 0 to 30.0 degrees | ||||||
BVD | O | N | Numeric | 03 | Vertex Fitting. Back vertex distance, as worn (mm) | Valid range of values is from 5 to 30 mm | ||||||
RVD | O | N | Numeric | 03 | Refracted Vertex Distance - Back vertex distance, as refracted (mm) | Valid range of values is from 5 to 30 mm
| ||||||
TRCFMT | O | N | Numeric | 01 | Format of frame trace data | Valid Entries are: | ||||||
Number | 04 | Number of radii in the trace | ||||||||||
String | 01 | Radius mode identifier | Valid Entries are: | |||||||||
String | 01 | Which eyes are included | Valid Entries are: | |||||||||
ZFMT | O | N | Numeric | 01 | Format of vertical height frame trace data | Valid Entries are: | ||||||
Number | 04 | Number of radii in the trace | ||||||||||
String | 01 | Radius mode identifier | E – the radii are evenly spaced | |||||||||
String | 01 | Which eyes are included | R – Right | |||||||||
R | C | N | Numeric | 05 | Radius Data | Separate values for this field by a semi-colon “;” such as: | ||||||
A | C | N | Numeric | 05 | Angle data for radius data (angular locations of trace radii expressed | Separate values for this field by a semi-colon “;” such as: | ||||||
Z | C | N | Numeric | 05 | Radius Data | Separate values for this field by a semi-colon “;” such as: | ||||||
CTHICK | O | Y | Numeric | 05 | Center thickness - used only if a specific center thickness is desired for the lens. This can | CTHICK=2.3;2.3 | ||||||
UPC | O | Y | Numeric | 12 | This is a translation code that can be used with the UPC translation file to specify either lens style, material, tint and treatment, or an addon code. This allows a third party system to send one code that can be translated on the Rx-Universe side into the lab's codes for the lens product. |
Optional Fields
Optional fields are parameters that are not required for all Rx's, but might be required for specific lens designs. For example, the Varilux S 4D lens style requires head-eye coefficient to be specified by the dispenser.
...
R=2547;2547;2548;2548;2549;2550;2550;2551;2552;2553;2553;2554;2556;2557;2557
R=2559;2560;2561;2562;2564;2565;2566;2567;2569;2570;2572;2574;2576;2578;2580
R=2582;2584;2586;2588;2590;2591;2593;2595;2597;2599;2602;2604;2606;2608;2610
R=2612;2614;2616;2618;2619;2620;2623;2625;2628;2631;2634;2637;2639;2637;2630
R=2619;2605;2590;2575;2558;2543;2530;2517;2503;2489;2475;2462;2447;2435;2424
R=2410;2399;2386;2375;2363;2352;2342;2333;2323;2314;2307;2299;2291;2284;2277
R=2272;2266;2261;2255;2250;2246;2242;2239;2236;2233;2233;2230;2229;2229;2229
R=2229;2229;2231;2232;2234;2236;2238;2242;2246;2249;2254;2259;2264;2269;2274
R=2280;2286;2292;2299;2307;2315;2323;2332;2342;2351;2361;2369;2379;2388;2398
R=2408;2417;2428;2439;2450;2460;2471;2482;2493;2505;2516;2527;2538;2549;2560
R=2570;2580;2591;2601;2610;2619;2627;2636;2644;2651;2658;2665;2672;2679;2684
R=2689;2692;2695;2697;2697;2698;2697;2696;2695;2692;2689;2685;2680;2674;2668
R=2660;2653;2643;2635;2627;2618;2610;2601;2593;2584;2575;2566;2557;2546;2537
R=2528;2518;2509;2499;2490;2480;2471;2462;2452;2444;2435;2426;2417;2409;2400
R=2392;2384;2377;2370;2363;2357;2351;2345;2340;2336;2331;2326;2322;2316;2312
R=2306;2302;2297;2293;2290;2286;2283;2280;2277;2274;2272;2268;2266;2263;2261
R=2258;2256;2253;2250;2248;2246;2243;2242;2240;2237;2236;2233;2232;2230;2227
R=2226;2224;2222;2221;2219;2217;2215;2215;2214;2212;2212;2210;2208;2207;2205
R=2205;2203;2201;2200;2198;2196;2194;2194;2192;2191;2191;2190;2191;2190;2191
R=2191;2191;2193;2194;2195;2197;2198;2198;2202;2204;2208;2209;2213;2215;2218
R=2222;2226;2230;2235;2239;2244;2249;2254;2260;2266;2272;2277;2284;2291;2298
R=2306;2314;2323;2332;2340;2348;2357;2368;2377;2387;2394;2405;2414;2424;2434
R=2444;2456;2468;2477;2490;2501;2511;2525;2536;2548;2559;2569;2580;2593;2603
R=2614;2617;2615;2611;2607;2604;2602;2599;2597;2594;2592;2590;2588;2586;2584
R=2581;2579;2578;2576;2574;2572;2570;2568;2566;2564;2562;2561;2560;2558;2557
R=2556;2555;2554;2553;2552;2551;2550;2549;2548;2548;2547;2547;2547;2546;2546
R=2546;2545;2545;2546;2545;2545;2546;2546;2546;2547
EOJ=END OF JOB
Sending Status Requests / Other
(See Appendix 4)
You can make requests from the lab through Rx-Universe; the types of requests that you can make are as follows:
Request quote (Rx-Invoice and Rx-Connect Modules Required at the Lab)
Request order status (Rx-Tracker and Rx-Connect Modules Required at the Lab)
Request to cancel the order
Request to hold the order
Request to ship the order
...
Field Name | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|
JOB | String | 07 | The original Job or PO number of the job that you are inquiring about. | |
_ACTION | Numeric | 01 | The type of request you are making. | Valid Entries are: |
Receiving Order Status
(See Appendix 4)
Order Status are received after an order is sent or the user can specifically make an order request. The retail system will have to pick the order status up from the lab. After an order is processed it creates a file in a folder that is specified in the Rx-Universe Remote Order Processing Options screen + “\” + Retail Account Number. The file name will consist of the “Job Number”.STA
...
Field Name | Data Type | Length | Description | Format / Valid Values |
---|---|---|---|---|
_LABID | String | 12 | The lab number | |
ACCN | String | 08 | The retailer’s account number with the lab | |
JOB | String | 21 | Job or PO number | |
_STATUS | Numeric | 02 | Order Status Code | Valid Entries are: |
_LABSTAT | String | 60 | Order Status Description | (see above field) |
_LABREM | String | 30 | Lab Remarks | Can occur multiple times |
_ESTCOMP | Date | 08 | Estimated Completion Date | YYYYMMDD |
_ESTCOST | Numeric | 10 | Estimated Cost | 99999999.99 |
_INVNO | Numeric | 08 | Invoice Number | 99999999 |
Appendix 1:
_LCODE:
RAW File:
DO=B
_LCODE=C IMAGE TR7BN3;C IMAGE TR7BN3
O/E Rx Screen:
Appendix 2:
_LSTYLE, _MATERIAL, _TINT and _TREAT:
...
DO=B
_LSTYLE=IMAGE;IMAGE
_MATERIAL=C;C
_TREAT=TR7;TR7
_TINT=BN3;BN3
O/E Rx Screen:
Appendix 3:
_TRACE:
RAW File:
_TRACE=FRAME-1
...
O/E Rx Screen:
In the Frame Traces:
Appendix 4 - Sending and Receiving Order Status:
Lab’s Rx-Universe requirements:
...