STANDARD DATA DICTIONARY #58.41 -- SPMP STATE PARAMETERS FILE 3/24/25 PAGE 1
STORED IN ^PS(58.41, (1 ENTRY) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 7.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file holds the set of parameters used in the transmission of controlled substance prescriptions to each State Prescription
Monitoring Program (SPMP).
While some of the parameters are updated by the user via a menu option, others are used internally for automated scheduled
transmissions.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
APPLICATION GROUP(S): PSO
CROSS
REFERENCED BY: STATE(B)
LAST MODIFIED: FEB 16,2024@11:32:38
58.41,.01 STATE 0;1 POINTER TO STATE FILE (#5) (Required)
LAST EDITED: JAN 16, 2013
HELP-PROMPT: Select the state for which the parameters apply.
DESCRIPTION:
This is the state for which the parameters apply.
CROSS-REFERENCE: 58.41^B
1)= S ^PS(58.41,"B",$E(X,1,30),DA)=""
2)= K ^PS(58.41,"B",$E(X,1,30),DA)
58.41,1 ASAP VERSION 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: DEC 15, 2015
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION: This is the American Society for Automation in Pharmacy (ASAP) format version required for the
State Prescription Monitoring Program (SPMP) data transmission.
58.41,2 INCLUDE NON-VETERAN PATIENTS 0;3 SET
'1' FOR YES;
'0' FOR NO;
LAST EDITED: MAY 21, 2013
HELP-PROMPT: Include prescriptions dispensed to non-veteran patients in the export file?
DESCRIPTION: This field indicates whether controlled substances prescriptions dispensed to non-veteran patients
should be included in the export file transmitted to the state.
58.41,3 REPORTING FREQUENCY IN DAYS 0;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>30)!(X<1)!(X?.E1"."1.N) X
LAST EDITED: MAY 23, 2016
HELP-PROMPT: Type a number between 1 and 30, 0 decimal digits.
DESCRIPTION: This is the frequency the state requires pharmacies to report data. The value represents the
number of days between transmissions of data to the state.
58.41,4 OPEN VMS LOCAL DIRECTORY FILE;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JAN 29, 2013
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION: This is name of the local Open VMS secure directory where the State Prescription Monitoring Program
(SPMP) export file will be created before it can be transmitted to the state (e.g., USER$:[SPMP]).
58.41,5 FILE NAME PREFIX FILE;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: DEC 13, 2012
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION:
This is the prefix that will be appended to the name of the export file transmitted to the state.
58.41,6 FILE EXTENSION FILE;3 SET (Required)
'.TXT' FOR .TXT;
'.DAT' FOR .DAT;
LAST EDITED: OCT 05, 2012
HELP-PROMPT: Select the extension of the export file transmitted to the state.
DESCRIPTION:
This is the extension of the export file transmitted to the state.
58.41,7 STATE SFTP SERVER IP ADDRESS FILE;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<5) X
LAST EDITED: DEC 08, 2015
HELP-PROMPT: Answer must be 5-60 characters in length.
DESCRIPTION: This is the secure FTP IP address of the State Prescription Monitoring Program (SPMP) server where
the export file will be transmitted to.
58.41,8 STATE SFTP SERVER USERNAME FILE;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: DEC 08, 2015
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION: This is the secure FTP username at the State Prescription Monitoring Program (SPMP) server where
the export file will be transmitted to.
58.41,9 STATE SFTP SERVER PORT # FILE;6 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: OCT 29, 2013
HELP-PROMPT: Type a number between 0 and 999999999, 0 decimal digits.
DESCRIPTION: This is the secure FTP port number used by the State Prescription Monitoring Program (SPMP) server
to receive the export file.
If left blank, the default secure FTP port 22 will be used.
58.41,10 STATE SFTP SERVER DIRECTORY FILE;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: OCT 29, 2013
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION: This is the directory name at the State Prescription Monitoring Program (SPMP) server where the
export file will be saved to.
If left blank, the default directory will be used.
58.41,11 LAST EXPORT DATE RUN EXPORT;1 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:X<1 X
LAST EDITED: NOV 26, 2013
HELP-PROMPT: Enter the last date exported to the state.
DESCRIPTION:
This is the last prescription release date/time exported to the state.
58.41,12 TRANSMIT RETURN TO STOCK 0;5 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: AUG 27, 2013
HELP-PROMPT: Indicate whether Return To Stock fills should automatically be transmitted to the state (in a
separate file) or if reporting of such records will be handled manually.
DESCRIPTION: This field indicates whether Return To Stock fills should automatically be transmitted to the state
(in a separate file) or if reporting of such records will be handled manually.
58.41,13 SFTP TRANSMISSION MODE 0;6 SET
'A' FOR AUTOMATIC [SSH KEYS];
'M' FOR MANUAL [PASSWORD];
LAST EDITED: MAR 17, 2016
HELP-PROMPT: Indicate whether the sFTP transmissions will happen automatically by a scheduled background job
using SSH encryption keys or if it will be performed manually by a user.
DESCRIPTION: This field indicates whether the sFTP transmissions will happen automatically by a scheduled
background job using SSH (Secure SHell) encryption keys or if it will be performed manually by a
user.
58.41,14 LAST RET TO STOCK RX EXPORTED EXPORT;4 POINTER TO PRESCRIPTION FILE (#52)
LAST EDITED: FEB 08, 2013
HELP-PROMPT: Select the last returned to stock prescription transmitted to the state.
DESCRIPTION:
This is the prescription that contains the last returned to stock fill transmitted to the state.
58.41,15 UNIX/LINUX LOCAL DIRECTORY FILE1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JAN 29, 2013
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION: This is name of the local Unix/Linux secure directory where the State Prescription Monitoring
Program (SPMP) export file will be created before it can be transmitted to the state (e.g.,
/usr/spmp/).
58.41,16 WINDOWS/NT LOCAL DIRECTORY FILE1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JAN 29, 2013
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION: This is name of the local Windows/NT secure directory where the State Prescription Monitoring
Program (SPMP) export file will be created before it can be transmitted to the state (e.g.,
D:\SPMP\).
58.41,17 RENAME FILE AFTER UPLOAD 0;7 SET (Required)
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAR 17, 2016
HELP-PROMPT: Answer YES if the export file should be renamed after being uploaded or answer NO if the export
file should have the final remote file name extension.
DESCRIPTION: This field indicates whether the data export file should be created and uploaded with a .DAT (or
.TXT) directly or if the file should be created and uploaded with a .UP extension and once the
upload completes the file would be renamed to .DAT (or .TXT).
NO - File will be uploaded as .DAT/.TXT directly (no renaming)
YES - File will be uploaded as .UP and then renamed to .DAT/.TXT
58.41,18 SFTP SSH KEY FORMAT EXPORT;2 SET
'OSSH' FOR OpenSSH Format (Used by Linux);
'SSH2' FOR SSH2 Format (Used by OpenVMS);
LAST EDITED: FEB 01, 2016
HELP-PROMPT: Choose the sFTP SSH key format used to transmit data to the state.
DESCRIPTION: This is the format of the SSH (Secure Shell) public and private keys used to transmit data to the
state via Secure File Transfer Protocol (sFTP).
58.41,19 SFTP SSH KEY ENCRYPTION EXPORT;3 SET
'DSA' FOR Digital Signature Algorithm (NOT SUPPORTED);
'RSA' FOR Rivest, Shamir & Adleman (Names);
'ECDSA' FOR Elliptic Curve Digital Signature Algorithm (ECDSA);
'EDDSA' FOR Edward-curve Digital Signature Algorithm (EDDSA);
LAST EDITED: SEP 01, 2023
HELP-PROMPT: Choose the sFTP SSH Key Encryption Algorithm used to transmit data to the state.
DESCRIPTION: This is the type of the encryption algorithm of the SSH (Secure Shell) public and private keys used
to transmit data to the state via Secure File Transfer Protocol (sFTP).
58.41,20 ZERO REPORT ASAP VERSION 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
MAXIMUM LENGTH: 10
LAST EDITED: OCT 26, 2020
HELP-PROMPT: Enter Zero Report ASAP Version. Leave blank if state does not require Zero Report. Answer must be
1-10 characters in length.
DESCRIPTION: American Society for Automation in Pharmacy (ASAP) Version for Zero Reporting to the State (no
prescription fills to report). Leave blank if the state does not require Zero Reporting.
58.41,21 SEND EXPORT STATE PARAMETER 0;8 SET
'0' FOR SEND TO STATE OF GEOGRAPHIC PHARMACY;
'1' FOR BOTH GEO PHARMACY STATE AND STATE OF DELIVERY;
'2' FOR SEND TO STATE OF PATIENT DELIVERY;
LAST EDITED: JUN 29, 2021
HELP-PROMPT: Choose the state for the batch export. NOTE: If sending to state of patient delivery, any state(s)
you want to receive data will need to be setup in SPMP state parameters.
DESCRIPTION: The Send Export State Parameter field determines how states will be identified for receiving the
SPMP batch exports.
Null or 0 - Use the geographic pharmacy state. 1 - Use both geographic state and state of
patient delivery.
NOTE: Only states that are set up in SPMP State Parameters
will receive data based on patient delivery
address. Enter a help desk ticket if you have
questions or need assistance. 2 - Use the state of patient delivery.
Appropriate for Meds by
Mail only.
58.41,22 ZERO REPORT DEFAULT DIVISION 1;2 POINTER TO OUTPATIENT SITE FILE (#59) (Required)
LAST EDITED: JUN 01, 2023
HELP-PROMPT: Enter the Default Division that is used for the Zero Report when the SEND EXPORT STATE PARAMETER
field is set to 2 (SEND TO STATE OF PATIENT DELIVERY) for the state.
DESCRIPTION: This field is used to specify the Default Division from file 59 OUTPATIENT SITE that provides the
Pharmacy DEA # that will be populated into the Zero Report. When the SEND EXPORT STATE PARAMETER
field is set to 2 (SEND TO STATE OF PATIENT DELIVERY) for the state, this field must be populated
in addition to parameter ZERO REPORT ASAP VERSION in order to generate a Zero Report. Zero Reports
are created when there are no controlled substances to report to the state for the reporting
period.
58.41,100 SFTP SSH PRIVATE KEY TEXT PRVKEY;0 WORD-PROCESSING #58.411
LAST EDITED: MAR 03, 2016
DESCRIPTION:
This is the Secure File Transfer Protocol (sFTP) private key text content.
LAST EDITED: MAR 03, 2016
HELP-PROMPT: Enter the Secure FTP SSH encrypted private key content to be used to send data to the state.
DESCRIPTION:
This is the Secure File Transfer Protocol (sFTP) private key text content.
58.41,200 SFTP SSH PUBLIC KEY TEXT PUBKEY;0 WORD-PROCESSING #58.412 (IGNORE "|")
LAST EDITED: MAR 03, 2016
DESCRIPTION:
This is the Secure File Transfer Protocol (sFTP) public key text content.
LAST EDITED: MAR 03, 2016
HELP-PROMPT: Enter the Secure FTP SSH encrypted public key text to be used to send data to the state.
DESCRIPTION:
This is the Secure File Transfer Protocol (sFTP) public key text content.
FILES POINTED TO FIELDS
OUTPATIENT SITE (#59) ZERO REPORT DEFAULT DIVISION (#22)
PRESCRIPTION (#52) LAST RET TO STOCK RX EXPORTED (#14)
STATE (#5) STATE (#.01)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):