Request File Elements

request header (hdr) elements note certain errors pertaining the record type and transmission file type fields could result the file not being processed, which would cause the response file to not be generated, preventing the visibility of resulting errors field field name data type code comments field values/examples 0 record type an3 mandatory assigns the following string of data to its desired action value hdr 1 version an3 5 mandatory indicates the version of medication history for populations value 3 0 2 sender id an15 mandatory a unique identification number assigned by surescripts indicating the sender of the file example p00000000023456 3 sender password an15 mandatory the password to be utilized by the customer to access the surescripts system example m94wj7cw6h 4 receiver id an1 15 mandatory a unique identification number assigned by surescriptsindicating the receiver of the file note s00000000000006 has been deprecated for patient file load the following ids are used for medication history for populations (panel and prescription notifications) s00000000000003 (medication history for populations) s00000000000005 (medication history for populations for health plans) 5 transmission control number an1 10 mandatory a unique identifier defined by the sender used to map the patient file load to the patient response file this field can contain numerical or alphabetical characters and must be unique to each file transmission example 1234567891 6 transmission date format ccyymmdd mandatory the date the file was transmitted to surescripts 7 transmission time format hhmmssdd mandatory the time the file was transmitted to surescripts 8 transmission file type an1 4 mandatory identifier indicating the type of patient load file which can accept patient enrollment based on the recordtype value in the detail information value pma 9 no longer in use, field present but will remain null 10 extract date format yyyymmdd mandatory the date the file was created (extracted) from the source example 20240603 11 usage indicator an1 mandatory indicates the environment where the transaction will take place values t = test p = production 12 patient population id an1 64 mandatory a value assigned to a population by the customer that is provided in the patient file load this field can contain numerical or alphabetical characters example highrisk 13 no longer in use, field present but will remain null 14 look back period in months n1 3 conditional configurable field specifying the number of months to look back from the request date if left blank, the field defaults to 12 months example 12 15 data source type an3 conditional field specifying the desired data sources (claims and dispensed fills) to include in the response file if left null, the default value is set to 0 values fil only dispensed fill data clm only claim data null claim and dispensed fill data 16 request start date format ccyymmdd conditional the beginning date (utc) for the desired history may be left empty or customized to pull data a maximum of 12 months the default value is set to 12 months from submission if left null example 20240531 17 request end date format ccyymmdd conditional the end date (utc) for the desired history the default value is set to submission date if left null cannot contain a future date example 20241201 request details (dtl) elements field field name data type code comments field values/examples 0 record type an3 mandatory assigns the following string of data to its desired action note patient file loads with pat or pnm record types cannot be combined with unr record types values pat – prescription notifications and panel enrollment pnm – panel management enrollment pma – prescription notification enrollment 1 record sequence number n1 10 mandatory unique number for the detail record in the received file where the first record begins with "1" and each subsequent record is incrementally increased by 1 as the file is processed examples • 1 • 2 • 3 2 assigning authority an1 64 mandatory id for the organization/system that assigned the related patient id example 1 3 44444 666 3 2 1 3 patient id an1 35 mandatory the patient specific unique identifier provided by the panel user example 593431 4 last name an2 35 mandatory the last name of the patient this field must contain more than 2 characters example wayne 5 first name an2 35 mandatory the first name of the patient this field must contain more than 2 characters example tom 6 middle name an2 35 conditional the middle name of the patient sent to aid in patient matching example j 7 prefix an1 10 conditional the prefix for the patient sent to aid in patient matching example mr 8 suffix an1 20 conditional the suffix for the patient sent to aid in patient matching example ii 9 address line 1 an1 55 conditional first line of the patient address without any c/o type information sent to aid in patient matching example 123 street avenue 10 address line 2 an1 55 conditional second line of the patient address without any c/o type information sent to aid in patient matching example unit #41 11 city name an2 30 conditional patient city name sent to aid in patient matching example jacksonville 12 state an2 55 conditional state in which the patient resides only united states addresses are supported note both state abbreviations and full state names are supported examples • colorado • co 13 zip code an5 10 mandatory patient zip or zip code must consist of five digits, an optional hyphen ( ), and up to four additional digits the first five characters must only consist of numbers examples • 55123 • 97116 2245 • 200607011 14 date of birth format ccyymmdd mandatory the date of birth for the patient 15 administrative gender an8 mandatory the gender as reported by the patient values m – male f – female n – non binary u – unknown 16 npi n10 mandatory (medication history for populations s00000000000003) conditional (medication history for populations for health plans s00000000000005) individual or organizational national provider identification (npi) of the requester of the medication history that is validated by surescripts against the national provider identification file to verify that it exists note a test npi can be used in staging, as no nppes validation is used during the testing process example 1234567893 17 end monitoring date format ccyymmdd conditional for pat record types this field indicates the date in which the customer desires the patient be removed from monitoring in prescription notifications if no end date is desired, leave this field empty note the end monitoring date must be set beyond the current date prescription notifications cannot be stopped retroactively 18 notifications requested for this patient an1 1000 conditional for the pat file type, this field allows for the customization of which notifications the customer would like to receive for the specific patient if this patient is to be monitored for a list of notifications that is shorter than the contracted list, include individual notifications requested in a comma separated list field is case insensitive recommendations leave this field empty to make it easy for contracting new notification types in the future without need for a patient file load reload if enrolling for specific notification types using this field, you must also include pmainfo in order to receive informational notifications (e g , patient is not found) values pmanewrx pmarefill pmanewprescriber pmacontrolledsubstance pmanorefillsremaining pmarefillnotpickedup pmacashpayrx pmamonitoredmedrx 19 patient primary telephone n10 conditional patient's primary telephone number example 5555551234 request trailer (trl) elements field field name data type code comments field values/examples 0 record type an3 mandatory assigns the following string of data to its desired action value trl 1 total records n1 10 mandatory summary of the total detail records submitted in the file examples • 1 • 2 detailed information for unenrollment this is an optional record and should only be used for mass unenrollment purposes field field name type code description example 0 record type an3 mandatory identifies record type value unr = unenroll patients note patient file loads with this record type cannot be combined with pat, pnm, or pma record types unr 1 record sequence number n1 10 mandatory number for this detail row in the file 1 2 product an3 mandatory product type allowed value is pma pma 3 end monitoring date dt8 mandatory this is the date when all patients who are currently being monitored will be unenrolled from prescription notifications (panel does not apply) this date must be set in the future from current date please be aware that specific patients cannot be unenrolled using this process 20231231