Admin Console User Guide 2013-12-06

ADMIN CONSOLE USER GUIDE
Date: December 6, 2013
ADMIN CONSOLE USER GUIDE

PUBLISHED BY
SURESCRIPTS, L.L.C.
920 2ND AVENUE S.
MINNEAPOLIS, MN 55402
PHONE: 866-267-9482
FAX: 651-855-3001
2800 CRYSTAL DRIVE
ARLINGTON, VA 22202
PHONE: 866-797-3239
FAX: 703-921-2191
WWW.SURESCRIPTS.COM
Copyright 2013 by Surescripts, LLC.
All rights reserved. Proprietary and Confidential.
This document and all other documents, materials, and information, transmitted or orally communicated
by Surescripts in the course of the parties dealings constitute and are hereby designated as
proprietary and confidential information of Surescripts, and may not be reproduced or distributed (in
whole or in part) without the express written consent of Surescripts..
Document Change Log

The table below tracks significant changes to the document made in the last few months.
Section
Section Title
Change Description
Last published on 10/24/2012.

Replace "prescriber" with "provider" and "pharmacy" with "pharmacy
organization or "type of" organization.
Added new and updated screen shots to reflect new verbiage and/or
service level options (ePA) as well as the addition of Organizations.
Through
out
1.1.1
Functionality
Added "clinical message transactions" and deleted "eligibility" from the

searchable transactions listed in the 3rd paragraph.
1.2
Service Levels
Deleted eligibility as it is not one of the options listed here.

Added ePA.
Added a note that the messages, RxFill, ReSupp and Census are not
currently supported on the network.
2.1
Accounts and Portals

Setup
Updated the production and staging links to the Admin Console.
2.2.6
Main Screen View
Welcome screen changed to Notices screen. Added information regarding

Notices.
2.2.7
Change Password
screen
Added screen shot of Change Password screen.
3.0
Directories
Clarified the 2 paragraph by replacing "participants" with "common

Surescripts' network portal.
3.1
Search Criteria
Added "or Include Active" to checkboxes in the 2nd paragraph.

Also added: Message Search by Provider screen, Message Search by
Organization screen.
Deleted Search Field Qualifiers and associated table with descriptions as
these are no longer being used in Admin Console.
3.2
Organization Search
Added detail to explain the search function for organization as opposed to

only pharmacy.
Removed Search Qualifiers from the fields used for search criteria as the
qualifiers are no longer used.
Added information on creating a parent organization for each organization.
Search criteria changes:
Added:
nd
Organization ID
Payer ID
Fax Portal State

Deleted:
Account
Radius
Fax Portal State
Portal
Changed:
"Activated" to "Include Active Organizations"

Added content pertaining to organizations.
Changes to the return fields:
LAST PUBLISHED 12/6/13
Changed "Pharmacy Name" to "Name" - Added details to the Name
COPYRIGHT 2013 BY SURESCRIPTS, LLC,

ALL RIGHTS RESERVED. PROPRIETARY AND CONFIDENTIAL
PAGE 3
Section
Section Title
Change Description
field description
Added "Org ID" field and description
Added "Parent Org" and description

Deleted:
Fax Pharmacy
Activated
Added Note following the table.
3.3
Provider Search
Added the fields:

- Direct Address
- Phone #
3.3.3
Provider Record
Detail
Added new table, "Additional Fields of Note:"
3.2.5.1
Million Hearts
Initiative
Added more detail and examples to the Million Hearts field descriptions.
3.5
Directory Download
Updated the description of the Nightly and Full download files.
3.5.1
Downloading
Directories Directly
from Admin Console
Updated the Note regarding versions.

Return fields table updates include:
- Date Updated added additional information
- File updated field description
- Download Link - Changed to "Version" and added new description.
Removed Best Practice note as it no longer applies.
Message Search
Added note regarding availability of CI messages for search.
4.1
Search Criteria
- Removed the field qualifiers table.

- Added to the descriptions for clarity and/or new functionality.
- Deleted "From Time" and "To Time (XXX)" search criteria and changed
"From Date" and "To Date" to: "From Date/Time" and "To Date/Time".
- Added Case ID and Reference ID for use with ePA.
4.1.1
Message ID Search
Criteria
Added Note.
4.1.3
Message Type
Search Criteria
- RXFILL Added "Currently not supported by Surescripts' processing."

- "SupportsLongDrugName" Deleted
- Removed "flat file" from DirectoryDownloadResponse description.
- UpdatePrescriber, SetMailbox & IDProofSM no longer used.
- RESUPP & CENSUS changed to not used.
- Added: PAInitiationRequest, PAInitiationResponse, PARequest,
PAResponse, PACancelRequest, PACancelResponse,
PAAppealRequest, and PAAppealResponse and new column for CI
Routing.
4.3.1
Message Summary
Added Message Status and Message Content to the list of components in

Message Summary.
4.3.3
Message Content
Detail
Added to the description for IncomingContentMessage.

Deleted HL7 from the message formats.
Message Search MedHistory Message
Changed section name from "Message Search Medication History

Message" to "Message Search MedHistory Message".
Removed references to Eligibility transactions.
5.1
Medication History
Message Type
Changed description for ELGREQ to "No longer used".

PAGE 4
Section
Section Title
Change Description
8.1
Case Management
Link
- Case Category moved to top of fields table.

- Case Type: changed to "Type" and replaced the description with current
content.
- Added fields: Case Initial Reason, Email and User Call Back Phone
8.2
Case Creation Using

Record Details
Updated the link name for creating a Case.

PAGE 5
This page intentionally left blank.

PAGE 6
Surescripts Admin Console Guide
Table of Contents
TABLE OF CONTENTS
SECTION 1
Introduction .................................................................................................. 9
1.1
1.1.1
1.1.2
1.2
About This Guide .................................................................................................... 9

Functionality ............................................................................................................ 9
Production vs. Staging environment ........................................................................ 9
Service Levels....................................................................................................... 10
SECTION 2
User Administration .................................................................................... 13
2.1
2.2
2.2.1
2.2.2
2.2.3
2.2.4
2.2.5
2.2.6
2.2.7
2.2.8
Accounts and Portals Setup .................................................................................. 13

User Setup ............................................................................................................ 14
User Profile Requirements..................................................................................... 14
User Permission Levels ......................................................................................... 14
General Support and Directory User IDs................................................................ 15
Individual User IDs ................................................................................................ 15
Password Reset or Unlock User ID........................................................................ 16
Main Screen View ................................................................................................. 16
Change Password ................................................................................................. 17
User Profile (Time Stamp) ..................................................................................... 17
SECTION 3
Directories .................................................................................................. 19
3.1
3.2
3.2.1
3.2.2
3.2.3
3.2.4
3.2.5
3.3
3.3.1
3.3.2
3.3.3
3.3.4
3.4
3.4.1
3.4.2
3.4.3
3.4.4
3.4.5
3.4.6
3.5
3.5.1
Search Criteria ...................................................................................................... 19

Organization Search.............................................................................................. 20
Search Results ...................................................................................................... 23
EDI vs. Fax Organization....................................................................................... 24
Organization Record Detail.................................................................................... 24
Applying Services to an Organization Record ........................................................ 26
Adding/Updating an Organization .......................................................................... 26
Provider Search .................................................................................................... 28
Provider Search Results ........................................................................................ 29
5th NewRx Sent .................................................................................................... 30
Provider Record Detail .......................................................................................... 30
Applying Services to a Provider Record ................................................................. 31
Provider Update Request (PUR)............................................................................ 32
Search for Providers.............................................................................................. 33
PUR Permission Search Results ........................................................................... 33
Selecting Providers ............................................................................................... 34
Adding Providers to the List ................................................................................... 34
View Provider List.................................................................................................. 34
Submit List of Providers......................................................................................... 35
Directory Download ............................................................................................... 36
Downloading Directories Directly from Admin Console ........................................... 37
SECTION 4
Message Search ........................................................................................ 39
4.1
4.1.1
4.1.2
Search Criteria ...................................................................................................... 39

Message ID - Search Criteria................................................................................. 40
Date/Time Range - Search Criteria ........................................................................ 40

PAGE 7
Table of Contents
4.1.3
4.1.4
4.2
4.3
4.3.1
4.3.2
4.3.3
Message Type - Search Criteria............................................................................. 40

Message Status.....................................................................................................43
Search Results ......................................................................................................43
Message Detail Screen..........................................................................................44
Message Summary................................................................................................44
Message Status.....................................................................................................47
Message Content Detail ........................................................................................ 48
SECTION 5
Message Search -MedHistory Message ..................................................... 51
5.1
SECTION 6
6.1
6.2
Medication History Message Type ......................................................................... 51
Report Log ................................................................................................. 53

Provider Reports ...................................................................................................53
Organization Reports.............................................................................................53
SECTION 7
PDMP ........................................................................................................ 55
7.1
7.2
7.2.1
7.2.2
Search Criteria ......................................................................................................55

Medication History Search ..................................................................................... 55
PDMP Search Results ........................................................................................... 56
Record Details .......................................................................................................57
SECTION 8
Support Case Management (Self-Service Portal) ....................................... 65
8.1
8.1.1
8.2
8.3
Case Management Link .........................................................................................65

Case Management ................................................................................................66
Case Creation Using Record Details ...................................................................... 67
Accessing Support Solutions ................................................................................. 68

PAGE 8
SECTION 1
1.1
Introduction
INTRODUCTION
ABOUT THIS GUIDE

This Guide was created to assist organization and provider vendor participants
with an understanding of the Surescripts Admin Console, a proprietary Web
application that provides an interface to information and transaction activity on the
Surescripts network, including directory informationwhich can be synchronized
with their systems, messaging history, and a testing platform.
1.1.1
FUNCTIONALITY
The Admin Console provides replicated visibility into the directories and messages
that transmit across the Surescripts network.
The organization and provider directories that are included within the Admin
Console provide the foundation for the transactions and also provide the vendor
participants with the necessary tools and resources to maintain updated directory
listings within their respective applications.
The messaging search functionality provided in the Admin Console allows the
vendor participant to search and review transaction activity associated with their
respective account in near real time. Currently, these transactions are limited to
retail and mail-order based scripts, clinical message, directory message and
limited medication history transaction activity that occurs on the Surescripts .net
network.
Additional functionalities include reporting, case management integration, and
account/portal set up review.
If you have questions concerning this guide or the Admin Console, please direct
them to your Surescripts Account Manager or the Surescripts Customer Care
Team at support@surescripts.com.
1.1.2
PRODUCTION VS. STAGING ENVIRONMENT

Prior to certification on the Surescripts network, vendor participants will have used
the staging version of the Admin Console. This test environment works under the
same functionality as the production version of the Admin Console; it is provided to
allow vendor participants the opportunity to test their application solutions in a
controlled environment.
Once certified, vendor participant connectivity will be activated in the production
version of the Admin Console; the production environment will display actual
records and transactions.

PAGE 9
1.2
Introduction
SERVICE LEVELS
Service levels are the foundation for transactions on the Surescripts network. All
vendor participants go through a certification process that allows vendor
participant customers (end-user provider or organization) to conduct business on
the network. A base list of the most common service levels is provided in the
following table. Please note that your account may not have access to all of these
service levels or may have service levels that are not listed in this table.
Service Level
Description
Disabled
Provider or organization cannot send/receive messages.
New
Prescriber can send a NewRx. Pharmacy Organization can receive NewRx.
Refill
Pharmacy Organization can send a RefillRenewalRequest and receive a

RefillRenewalResponse.
Provider can receive a RefillRenewalRequest and send a
RefillRenewalResponse.
Controlled
Substance
Provider can send a prescription for a controlled substance. Pharmacy

Organization can receive a prescription for a controlled substance.
Change
Organization can send an RxChangeRequest to a provider and receive an

RxChangeResponse from a provider.
Provider can receive an RxChangeRequest from a pharmacy organization and
send an RxChangeResponse to a pharmacy organization.
Cancel
Provider can send the RxCancelRequest to a pharmacy organization and receive

an RxCancelResponse from a pharmacy organization.
Pharmacy organization can receive an RxCancelRequest from a provider system
and send an RxCancelResponse to a provider.
RxFill
Pharmacy organization can send a FillStatus either new or refill.

Provider can receive a FillStatus. This message is not currently supported on the
network.
MedHistory
Provider/organization can receive patient medication history.
ReSupp
A long-term care (LTC) facility can send a RefillRenewalRequest to a pharmacy

organization. A pharmacy organization can receive a RefillRenewalRequest from
an LTC facility. This message is not currently supported on the network.
Census
A long-term care (LTC) facility can send a Census message to a pharmacy

organization. A pharmacy organization can receive a Census message from an
LTC facility. This message is not currently supported on the network.
CCR
Allows the provider to be a recipient of a Continuity of Care Record (CCR)

message from a convenience clinic.
CIMessage
Participants can send/receive clinical messages.
CIEvent
Participants can send/receive event messages related to a clinical message.
ePA
A provider can send electronic prior authorization messages to a payer

organization and receive electronic prior authorization messages from a payer
organization. This product is called CompletePA.

PAGE 10

Introduction
PAGE 11
Introduction

PAGE 12
SECTION 2
2.1
User Administration
USER ADMINISTRATION
ACCOUNTS AND PORTALS SETUP

Admin Console is an encryption-based tool on a restricted gateway. If you are
unable to connect to the Admin Console Login page, ask yourself: Am I coming
through my companys gateway or VPN?
To Open a Web browser for the production environment, click on the link:
https://admin.surescripts.net/AdminConsole/Administration/Login.aspx or click
https://staging.surescripts.net/AdminConsole/Administration/Login.aspx/ to go to the
Staging environment.
Type your valid user name and password in the Login ID and Password fields.
Passwords are case-sensitive. Click the Login button. See Section 2.2.5
Password Reset or Unlock User ID for more information.
Note: If you forget your password, click the Forgot your password? link and enter your Login ID.
Your new login information will be sent to the email on record for your Login ID.

PAGE 13
2.2
2.2.1
User Administration
USER SETUP
USER PROFILE REQUIREMENTS
The following elements are required for a User ID Profile.
2.2.2
Field Element
Description
First Name
Users first name.
Last Name
Users last name.
Email Address
The email address that will be used for password resets.
Start Date
The date the user ID is created
End Date
The default activation period for a new account is one year. Surescripts Customer
Care can extend the active user date for a user ID.
User ID
By default, the User ID is usually the first initial of the first name and the entire last
name. In cases of duplicate names, a unique user ID will be created for the
individual.
USER PERMISSION LEVELS

User permission levels are assigned to User IDs. The vendor participant is
responsible for determining the permission levels for their users. Not all permission
levels may be available to everyone.
To assign the permission level with visibility to patient information (protected health
information/PHI), an administrator or manager of the vendor participant must log a
case in the Self-Service Portal. See Section 8: Support Case Management for
more information on the self-service portal.
Permission Level
Organization/Provider
Search
Message
Search
Message
Content
(PHI)
Directory
Download
Report
Log
Basic
Read only
Yes
No
No
Yes
Admin
Read/Write
Yes
No
Yes
Yes
Message PHI Search
N/A
Yes
Yes
N/A
N/A
Provider Update
Request
Read only
No
No
No
No
Service Locator
Oragnization TypePharmacy only

Read/Write
No
No
No
No
Additional user permissions (e.g. CSPMedHistoryAccess, CSPMailboxAccess) are

available and associated with User IDs based on certified service levels and access
needs. These additional permissions are mentioned in the appropriate sections of
this document. A request to Surescripts Customer Care must be made to assign
additional user permissions.
A User Management Access permission level is available to a single admin or
management team member of each vendor participant account. This permission
level will allow the user to:

PAGE 14
2.2.3
User Administration
Unlock User IDs
Reset passwords
Create individual User IDs with the Basic permission level (no PHI
access)
GENERAL SUPPORT AND DIRECTORY USER IDS

These are established when a new account is added to production. Both initial
User IDs are created for new accounts to allow for initial interaction with the tool
and both allow concurrent access.
General Support User IDs
General Support User IDs are assigned an Admin User permission level. The
General Support User ID should be available to any vendor participant team
member who requires the ability to review transactions on the network and
view/update account records.
Directory User ID
By default the user ID is assigned an email from the accounts Implementation
team. The Directory User ID is designed for behind-the-scenes directory
administrative tasks. The Directory User ID is assigned the
CSPDirectoryUpdateBasic User permission level.
Note: General support and Directory User IDs do not receive PHI visibility access.
2.2.4
INDIVIDUAL USER IDS

Individual User IDs are created upon request of the vendor participant. These
Individual User IDs are often set up to provide specific access, including visibility to
PHI. It is up to the vendor participants account administrator to determine who
should have PHI access; the vendor participant is responsible for any internal
background investigations or protocols to determine PHI access eligibility.
To request an Individual User ID, an administrator or management team member
of the vendor participant account must log a case with Surescripts Customer Care,
using the Self-Service Portal, and provide the necessary profile information to
include:
Name
Email address
Direct telephone number
User Permissions
PHI Access (yes or no)

PAGE 15
2.2.5
User Administration
PASSWORD RESET OR UNLOCK USER ID

Password Reset
To reset your password, enter your User ID, click Forgot your password, and the
email address associated with the User ID will receive an email with a new
password.
Note: Resetting a password will not unlock an account.
Unlock User ID
Security protocols dictate that after three failed attempts, the User ID is locked.
The user may contact Surescripts Customer Care to unlock their ID before they
are able to proceed, or the individual with the User Management Access
permission level for their account may also unlock the User ID.
The following four methods may be used to have your User ID unlocked with
Surescripts Customer Care:
Email
Live Chat
Phone
Self-service portal (SSP)
All passwords must be changed every 90 days, except Directory User IDs, which
have passwords that do not expire due to their functionality.
2.2.6
MAIN SCREEN VIEW

Once youve logged in successfully, the Notices screen opens. The menu bar on
the left-hand side controls the functionality in the active window on the right-hand
side of the screen.
Notices are used by Surescripts to communicate information to our participants on
the network. Users will see the notices upon login and can check for any updated
notifications by selecting the Notices link in the top right-hand corner.
Note: If no notices are available, the Welcome message will display.

PAGE 16
2.2.7
User Administration
CHANGE PASSWORD
To change your password, click the Change Password button, enter the old
password and enter the new Password twice.
Note: Fields with a red asterisk (*) are required.
2.2.8
USER PROFILE (TIME STAMP)

UTC (Coordinated Universal Time). A time standard based on International Atomic
Time with leap seconds added at irregular intervals to compensate for the Earths
slowing rotation. This is the baseline time stamp for all Surescripts transactions. By
default, a users profile is set to UTC.
The user may prefer to set the Admin Console Message Search interface to their
local time zone. In order to set your local time zone, click the User Profile button
and select the desired time zone from the drop-down list. Check the Observe
Daylight Savings Time check box if applicable; this feature will automatically
engage. This time zone will be used for all search functionality.

PAGE 17
User Administration

PAGE 18
SECTION 3
Directories
DIRECTORIES
The Surescripts network consists of two database directories, Organization and Provider.
Admin Console allows manual view, creation, and update to these directories, as well as the
ability to download aggregate copies of the data. Specific functionality is outlined in the
following sections.
Alternately, Surescripts provides the ability for the same functionality behind the scenes
through Surescripts directory messaging. Directory messaging is a scripting interface
directed through a common Surescripts' network portal and is recommended for large
batches.
For additional information on Surescripts directory messaging, refer to the appropriate
version of the Surescripts Directories Guide for your account.
3.1
SEARCH CRITERIA
Once a record has been created, it is never purged from the system. Users should
always search for both Activated and Deactivated records.
Activated The Activated or Include Active check boxes, when selected, will
return results for those profiles and records that have an active end-date in the
future. Active records will display in the search results and in directory download
files. Records that are inactive will not be conveyed in a directory download file.
Deactivated Deactivated records are those in which the Active End Date has
passed and there is no service level. When a record is deactivated, it will appear in
a directory download for the account to which it is assigned. This enables the
participant owner to see all records associated with their account whether active
or inactive. If a provider record is deactivated, it will be conveyed in the download
files provided to organization vendors for a period of thirty days after the Active
End Date. The same is true for deactivated organizations.
Any combination of fields may be used to conduct a search. Required fields are
designated with a red asterisk (*). Specific formats are indicated with watermarks
and help text (click on the "?") to provide additional information. See sample
screens below.

PAGE 19
Directories
Message Search
Message Search by Provider
Message Search by Organization
3.2
ORGANIZATION SEARCH
The Organization Search functionality allows users to view active and inactive
Organizations available on the Surescripts network.
Organization users will have visibility into their specific account profiles;
Administrative users will have the ability to read and/or write; whereas Basic users
will have read-only access. All provider accounts will have read-only visibility into
all organization types.
To manually search and work with a profile, click on the Organization menu
button. The Search screen allows the user to select and search all organizations
or a specific organization type (pharmacy, general or payer). Note the unique
identifiers that are valid for Pharmacy (NCPDP ID) and Payer (Payer ID) searches.
Deselect Include Active Organizations to search for inactive organizations. Click
the Reset Selections link to clear the form for a new search.

PAGE 20
Directories
The following fields can be used for search criteria.

Field Name
Description
Organization Type
Options:
- General
- Pharmacy
- Payer
Organization ID
Up to 10-digit ID assigned by Surescripts. This ID is returned to the user

when creating any of the organization types, either in response messages
or via the screen after entry.
Payer ID
This ID is assigned to the payer organization by Surescripts. This field is

editable only when the Payer organization type is selected.
NCPDP ID
7-digit NCPDP ID for the pharmacy organization. This field is editable only
when the Pharmacy organization type is selected.
Name
Name of organization.
Store
Store number assigned by pharmacy chain, if applicable.
Phone
Organization phone number.
Service Level
Surescripts service levels assigned to the organization.
Fax Portal State
Some pharmacies on the Surescripts network are designated as a Fax

organization location. Not all providers will have visibility into this
Surescripts subscription-based directory.
Address
Organization street address
City
City where the organization is located
State
State where the organization is located
Zip
Organization zip code
Include Activate
Organizations
When selected, returns those accounts whose Active End Date is in the
future. When not selected, returns those accounts whose Active End Date
has passed.
Users with Admin rights to read/write organization records will also see a Create
New Organization link displayed. This link enables the vendor participant to
create a new organization location.

PAGE 21
Directories
Users will have an option to create a Parent Organization for each organization.
Please refer to the Directories 4.6 Implementation Guide for more information on
Parent Organizations.
The Organization type will default based on the user profile association.
When creating a pharmacy organization, the NCPDP is required, as indicated by
the asterisk. When creating a General organization, no additional identifiers are
required. When creating a Payer organization, the 15 digit payer ID that is used for
Medication History is required.

PAGE 22
Directories
Users have an option to create a Parent Organization for each organization.

Please refer to the Directories 4.6 Implementation Guide for more information on
Parent Organizations. This parent organization must be associated to the same
account as the organization being created in order to be displayed as an option for
selection. This is accomplished by selecting the "+".
Note: Organizations cannot become a parent of themselves, causing circular references.
3.2.1
SEARCH RESULTS
Search results are returned in the window below the Organization Search
section.
Inactive and Pharmacy in Name Field
Fax and Pharmacy in Name Field
Indicates Payer
The return fields include the following:

Field
Description
Name
Name of the organization.

Organization type is indicated by icons in the Name section.
Rx = pharmacy
P = payer
Red X = inactive
Fax sheet = fax
Click on the link to go to the record detail.
Org ID
Organization ID as assigned by Surescripts upon creation.
Parent Org
Parent Organization ID that has been attached to the organization record.
NCPDP ID
The organization's 7-digit NCPDP ID.

PAGE 23
Directories
Field
Description
Store #
Store # assigned by pharmacy chain, if it was provided.
Service Level
Surescripts service levels assigned to the organization.
Phone #
Main organization phone number.
Address
Displays Address Line 1. Click on the link to go to Google Maps.
City
City where the organization is located.
State
State where the organization is located.
Zip
Organization zip code.
Note: All columns are sortable by ascending/descending order indicated by arrows when
selecting the header row entry.
3.2.2
EDI VS. FAX ORGANIZATION

The first column (name) in the Organization Search Results screen indicates if
an organization is Fax-based. Refer to Fax and Pharmacy in Name Field screen
above.
EDI-based
An EDI-based pharmacy organization receives transactions from the Surescripts
network electronically directly into their application; no additional manual workflow
is required to capture the transaction in the pharmacy organization system.
Note: Prescriptions for controlled substances cannot be delivered by Fax; only via EDI to
pharmacy organizations certified for controlled substances (EPCS).
Fax-based
A Fax-based pharmacy organization receives transactions that were converted by
the Surescripts network into a fax hard-copy document. These documents must be
manually entered by the pharmacy organization into their system.
Visibility into a fax-based pharmacy organization is contingent upon the account
subscribing to the Surescripts Fax Gateway. The Surescripts Fax Gateway is an
optional contractual subscription available to provider accounts. If you are unable
to see a fax pharmacy organization in the Admin Console, it is most likely because
your account does not subscribe to the Surescripts Fax Gateway.
3.2.3
ORGANIZATION RECORD DETAIL

Click on the organization name to access the record detail. There are several
fields available within a profile record that can contain information. Required fields
are designated with a red asterisk (*) and are listed in the table below. Additional
field elements are optional and maybe be included. For more information on
optional fields, please refer to the current version of the Surescripts Directories
Guide.

PAGE 24
Directories
Required Profile Fields

Field Name
Field Description
Organization Type
- Pharmacy
- General
- Payer
Organization Name
Best Practice: The common name used by providers and patients.
NCPDP
The 7-digit NCPDP ID for the pharmacy organization. This field is only valid for
pharmacy organization types.
Payer ID
The 15-digit code assigned by Surescripts for the Payer Organization. This field
is optional for other organization types.
Address Line 1
Actual physical street address of the organization.

Note: No PO boxes or building names may be included.
City
The city that is associated with the physical address of the organization.
State
Select the state from the drop-down list.
Zip
Zip code may either be 5 or 9-digits Do not include punctuation (hyphen).
Primary Phone
10-digit telephone number (includes area code). Do not include punctuation

(hyphen).
Fax
10-digit number (includes area code). Do not include punctuation (hyphen).
Active Start Date/Time

(UTC)
Date the record was activated.
Active End Date/Time

(UTC)
The date the record will be or has been deactivated.
Directory Specialties
Used for pharmacy stores.

Valid store types:
- Retail
- Mail Order
Service Level
See Section 3.2.4 Applying Services to an Organization Record for details on

assigning service levels. See Section 1.2 Service Levels for Service Level
Definitions.
Click the Mailbox Setup link (shown below) associated with the end-user profile if
you are a vendor participant who utilizes Mailboxing as part of your transaction
routing.

PAGE 25
Directories
Note: Vendor participant User IDs must have the CSPMailboxAccess permission to create or
update the profile Mailboxing fields as shown below.
3.2.4
APPLYING SERVICES TO AN ORGANIZATION RECORD

Each account is certified for specific service levels on the network. A complete
overview of service levels is found in Section 1.2 Service Levels. Users may only be
assigned those certified service levels available to the account.
To activate a service level within the record detail, select the check boxes for the
desired functionality. A record may have more than one active service level.
Note: Selecting a service level for which an account is not certified will result in an error when
attempting to save the record.
3.2.5
ADDING/UPDATING AN ORGANIZATION
Organization profiles can be created or updated by users with an Admin
permission level. All of the required profile fields, as presented in Section 3.2.3
Organization Record Detail, must be present to create or modify the record. The
Account and Portal will default to the account associated to the users login.
Accounts with multiple portals may require selecting from the available options in
the Portal drop-down.
Once service levels have been selected, ensure that the Active End Date/Time is
set into the future, e.g. 12/31/2099, and save the record.

PAGE 26
Directories
Note: Check the Disabled (Service Level = 0) service level check box to remove all active
service levels. The will default to current date and time date once the record is saved.
3.2.5.1 MILLION HEARTS INITIATIVE PARTICIPANT UPDATING A PHARMACY ORGANIZATION

The Million Hearts section of the Organization Record Detail page is visible to
users with the ServiceLocationAccess role and the ServiceLocator permission
level.
Click the Organization Name to access the record detail for the organization you
wish to update. The Organization Record Detail page opens.
Go to the Million Hearts Participant Information section of the Pharmacy
Organization Detail screen. Start Date is required if any other field is present.
Additional field elements are optional and may be included.
Million Hearts Fields
Field Name
Field Description
Pharmacy
Organization Website
URL
The Pharmacy Organization website URL, if applicable.

Note: Pharmacies without URLs may also participate in the Million Hearts
Program.
URL Caption
The caption to be used with the Pharmacy Organization Website URL.

For example, this caption could read Pharmacy Organization Store in
reference to the associated Pharmacy Organization URL. This field may
be left blank if a Pharmacy Organization does not have an associated
URL.
Store Information
Store-provided information related to the Million Hearts program that the

sotre wants to share with the customer.
For example, this field could be used to provide specific instructions,
information, or offerings of interest to the Million Hearts customer.
Start Date
This field is required if any of the other fields contain data.

A Start Date may be used to indicate the start of the Million Hearts
program, which may be the date the Pharmacy Organization is enrolled,
or a future date if the service start date will be delayed.
End Date
The End Date may be left blank or it can be used to indicate the last date
the Million Hearts program will be active for this Pharmacy Organization.
Maintenance of the Million Hearts Store Location information is not supported

through Directory Messaging.

PAGE 27
3.3
Directories
PROVIDER SEARCH
The Provider Search functionality allows users to review active and inactive
provider accounts available on the Surescripts network.
The Account field drop-down defaults to the users account. To view all providers
in the directory, select All from the Account field drop-down. Provider users will
have read-only visibility into all providers on the network, whether they are
associated to their user account profiles or not. Admin users will have the ability to
read/write for providers associated to their account; Basic users will have readonly access. All organization accounts will have read-only visibility into all provider
profiles.
To manually search and work with a profile, click on the Provider menu button.
Select the Search for this Provider button at the bottom of the screen to search
available records.
Select the Reset Search Input button to clear the fields and start a new search.
The following fields can be used for search criteria.

Field Name
Description
Last Name
Last name of the provider.
First Name
First name of the provider.
Clinic Name
Name of the clinic.
Direct Address
Used in clinical messaging to identify an endpoint (a sender or receiver) when

information is exchanged. The Direct Address has two parts, a Health End Point
Name and a Health Domain Name.
For example, drbob@sample-direct.com.
The Direct Address is also sometimes referred to as a Health Internet address.
Address
Physical street address. P.O. Boxes are not allowed.
City
Provider city
State
Provider state.
Zip Code
Provider zip code.

PAGE 28
3.3.1
Directories
Field Name
Description
SPI
Surescripts Provider Identifier, unique for each provider/location
NPI
National Provider Identifier
DEA
Drug Enforcement Agency (identifying number)
Phone #
Provider phone number.
Service Level
Surescripts service levels for which the provider is assigned.
Account
Defaults to the users account. To view all providers in the directory, select All from
the Account field drop-down
Note: To see All providers, All must be selected for both Account and Portal fields.
Portal
Defaults to all Portals that are associated with the users account and the Portal field
contents will be limited to those portals associated to the users account and All.
A specific portal will display only providers for the selected portal.
Note: To see all providers, All must be selected for both Account and Portal fields.
Activated
When selected, returns those accounts whose Active End Date is in the future. When
not selected, returns those accounts whose Active End Date has passed
(Deactivated).
Include
Fax/Mail
Delivery
Providers
When selected, results will include any providers that are accessible for Clinical
Messaging via fax or mail delivery.
PROVIDER SEARCH RESULTS

Search results are returned in a window below the Search for Provider criteria.
Select the clipboard icon in the Provider Name column to place the contents of the
Provider Results row onto the clipboard for a quick Copy-Paste function.
Return fields include the following:

Field
Description
Provider Name
Last name followed by a comma, space, first name and middle name.
SPI
13-digit SPI
Service Level
Surescripts' service levels assigned to the provider.
NPI
10-digit numeric identifier
DEA
9-digit alpha-numeric identifier
Clinic Name
Name of clinic
Org ID
10-digit Parent Organization ID.
Address
Address Line 1 and Address Line 2. Click on the link to go to Google Maps.
City
Cclinic city.

PAGE 29
Field
Directories
Description
State
Clinic state.
Zip
Clinic Zip code.
5 NewRx Sent
Indicates if the provider has sent their fifth (5 ) NewRx transaction on the
network and the date the 5th NewRx was sent.
Active
Indicates if the provider is active with a Yes or No.
th
Note: All columns, except 5 NewRx Sent and Active are sortable descending/ascending
indictaed by arrows when selecting the header row entry.
3.3.2
5TH NEWRX SENT

The 5th NewRx Sent column in the Search Results window provides the date
that the provider sent their 5th NewRx transaction on the network. Within the
provider directory download that is received by the pharmacies, a provider is not
eligible for EDI refills until the 5th NewRx Sent column is populated with a date.
Once eligible, the pharmacy organization will match (enable) the provider for EDI
refills within their store database.
Best Practices: Providers will continue to receive faxed refill requests until matched for EDI refills
by each respective organization. If your provider continues to receive faxed refills
after 30 days from the Active Prescribing Date, log a case with Surescripts
Customer Care.
3.3.3
PROVIDER RECORD DETAIL

Click on the Provider Name in the search results window to access the record
detail for that provider. There are several fields available within a profile record that
can contain information. Required fields are designated with a red asterisk (*) and
are listed in the table below. Additional field elements, e.g. State License Number,
are optional and may be included.
Required Profile Fields
Field Name
Field Description
First Name
First name of the provider. Do not include salutation.
Last Name
Last name of the provider. Do not include suffix or credential.
NPI
An NPI identifier is required. This field is required unless the provider

supports ONLY CI messaging (CIMessage and CIEvent).
DEA
A DEA identifier is required if the provider will be sending Controlled

Substance prescriptions, new or renewal, across the network
Including this information is preferred.
Address Line 1
Physical street address of the provider location.

Note: No PO boxes or building names may be included.
City
City associated with the physical address.
State
Select state from drop-down.
Zip
May be 5 or (non-hyphenated) 9-digit zip code. Do not use punctuation.

PAGE 30
Directories
Field Name
Field Description
Primary Phone
10-digit telephone number. Do not use punctuation. This field is required

unless the provider supports ONLY CI messaging (CIMessage and
CIEvent).
Fax
10-digit fax number. Do not use punctuation. This field is required unless
the provider supports ONLY CI messaging (CIMessage and CIEvent).
Service Level
See Section 3.2.4 Applying Services to an Organization Record for details

on assigning service levels; see Section 1.2 Service Levels for definition
of service levels.
Active End Date (UTC)
The date the record will be or has been deactivated.
Note: Vendor participants who utilize Mailboxing as part of their transaction routing must also
complete the Mailbox Setup link associated with the end-user profile. See Section 3.2.3
Organization Record Details for more information.
Additional Fields of Note:
3.3.4
Field Name
Field Description
Clinical Message
Direct Address
Direct Address of Provider to be used for Clinical Messaging

Note: Special formatting rules apply.
Default Location
Service Level
Total Service Level value for all services that should use the specified location as
the default location.
This value will be used to determine the correct prescriber location, data provider,
or pharmacy to deliver Clinical Messages and Clinical Events using a DIRECT
address over the Net2Net REST Protocol.
If you are not using Surescripts Net2Net Direct with the Net2Net REST protocol,
this optional field should be left blank.
If you are using Net2Net REST and this is the default location for the associated
Direct Address, set the DefaultLocationServiceLevel to "16384" (the value for
CIMessage service level).
Unlike SPIs and NCDPD IDs, nHIN DIRECT addresses are not location-specific.
DIRECT addresses may be shared across many prescriber location records, or
even across multiple health care providers. Therefore, Directory messages allow
the registering participant to specify a default location for the CIMessage service
level. The default location will be used to determine the Portal, ServiceLevel and
other delivery information for all messages addressed to the specified DIRECT
address.
Every Direct Address assigned to a Net2Net Rest recipient MUST have exactly 1
routable entity registered with a DefaultLocationServiceLevel for the CIMessage
service level.
Use Case
Use cases are used to identify participants whose applications are capable of
sending and receiving specifically defined content. Valid values will be distributed
in documentation specific to each use case.
APPLYING SERVICES TO A PROVIDER RECORD

Each account is certified for specific service levels on the network. A complete
overview of service levels is found in Section 1.2 Service Levels. Users may only
be assigned those certified service levels available to the account.
To activate a service level within the Record Detail, select the check boxes for the
desired functionality. A record may have more than one active service level.

PAGE 31
Directories
Note: Selecting a service level for which an account is not certified will result in an Error when
attempting to save the record.
3.3.4.1 CI MESSAGING - APPLYING USE CASES TO A PROVIDER RECORD

A use case is an optional attribute of a Clinical Message that informs the recipient
of the intent of the Clinical Message. The Clinical Message Service must first be
enabled before selecting/enabling a Use Case.
The configured use cases will appear as a check box list, as shown in the example
below. A maximum of ten Use Cases is supported. Please refer to Directories 4.5
or later version for additional information regarding Use Cases.
Use Cases Example
3.4
PROVIDER UPDATE REQUEST (PUR)

Provider Update Request (PUR) process allows provider vendor participants to
request moving a provider SPI connected to the Surescripts network from one
participant vendor to another. This process is specifically designed to allow the
transition of a provider at a specific location from one software vendor to another.
These PUR vendor switch controls appear at the bottom of the provider search
window.
The PUR function is visible to users with the Provider Update Request permission
level. Users with the Provider Update Request Access role will see the Provider
Update Request options in the Provider Search screen.

PAGE 32
3.4.1
Directories
SEARCH FOR PROVIDERS

From the Provider Search screen, select the list of providers for whom you wish
to switch vendors.
Only providers who are not currently members of the provider vendor account may
be added to the provider vendor list and these providers are identified with a
checkbox allowing their selection.
Click the checkbox for a provider's name to select themfor inclusion in the Provider
Update Request.
3.4.2
PUR PERMISSION SEARCH RESULTS

Users with the PUR Access role have access to open provider detail screens for
providers in those accounts associated with the user. If the users account
matches the provider account, the provider name will appear as a link in the
search results grid.
Note the clipboard icons next to the prescriber names in the screen below.

PAGE 33
3.4.3
Directories
SELECTING PROVIDERS
Select the providers to be included in the Provider Update Request.
Click the check box next to the name of one or more providers from the search
results window or click the Select All button to enable all of the checkboxes.
The selected providers display highlighted in yellow. Note the clipboard
icon/function next to the provider name in the search results below.
The selected list of providers is limited to 100. If the 100 provider limit is reached
when creating the list, a pop-up window states the limit has been reached for total
number of providers that can be submitted in a single vendor switch case.
3.4.4
ADDING PROVIDERS TO THE LIST

To add the selected providers to the PUR list, click the Add to List button. An
informational pop-up will display when providers are added to the list to indicate
the number of providers on the list.
3.4.5
VIEW PROVIDER LIST

To see a list of the selected providers, click the View List and Submit List button.
The list is sorted alphabetically by name and provider SPI. The following actions
are available on the View List tab:
To remove a provider from the list: Click the check box next to the provider name
to select it and click the Remove Selected from List button.
To conduct a different search: Click the Add More Providers to List link and
conduct a different search. For example, search for providers by address; then
search for more by DEA numbers.

PAGE 34
3.4.6
Directories
SUBMIT LIST OF PROVIDERS

After viewing the list, you may either select the Submit List tab or select the
Complete Form button to switch to the Submit List view. Once on the Submit
List tab, enter data into all of the fields and click the Submit List button (shown
above) to complete the Provider Update Request. All fields on the form are
required.

PAGE 35
Directories
Submit List fields

Field Name
Description
Name of Authorized Practice

Contact
The complete name of the practice manager, office manager, or lead

partner.
Practice Email Address
The general email of the practice or the email leading to the

Authorized Practice Contact.
Practice Phone Number
General phone number or Authorized Practice Contact phone

number.
Vendor Name
The name of the provider software account that is submitting the

request.
Account
The Account drop-down displays only accounts owned by the user.

Selection of an incorrect account can cause delays.
Portal
The Portal drop-down displays only portals owned by user

permissions. Selection of an incorrect portal can cause delays.
Services
The service level(s) to be assigned to the provider(s).
Update Request Address

Verification
Include all address(es) associated with this request. If the

address(es) do not match the address(es) for the selected
provider(s), there may be a delay in processing the request, as
additional information may be needed.
Request Effective Date
The date range available is within 96 business hours (4 days) from

the current date.
Requested Effective Date should not be a weekend or Surescripts
holiday.
Certify Checkbox
The Submit List button may be selected after the I hereby certify...
checkbox has been selected.
When the Submit List button is selected, a SalesForce Case is created with the
data that was entered into the Submit Form tab. The system will also create a
.CSV file of the selected provider data and attach it to the case.
3.5
DIRECTORY DOWNLOAD
All vendor participant accounts should have scheduled auto directory downloads
through Surescripts Directory Messaging. These scheduled downloads provide
regular, consistent, and current directory data for the receivers directory. For
example, provider vendor participants will download providers and organizations,
and organization vendor participants will download providers. See the Surescripts
Directories Guide for details.
As a supplemental option, you may use the Directory Download function in the
Admin Console to download all the respective organization or provider directory
files for which you have access privileges. Vendor participants would also benefit
from downloading their Surescripts database records to synchronize their user
database with the Surescripts network.
To access the Directory Download function in Admin Console, click the Directory
Download button from the menu options.

PAGE 36
Directories
The download files themselves come as a fixed-length text file, compressed using
Zip for versions 4.5 and lower and a pipe delimted file for version 4.6 and higher.
The fixed-length file format (schema) is specified in the Surescripts Directories
Guide. Please note that there are distinct specific schemas for the organization
download and the provider download.
Two types of daily directory downloads are posted: Nightly and Full. Nightly files
contain the deltas since the previous days posted download. The nightly directory
files are generated Sunday through based on those existing provider directory
entries with a last modified date of the previous business day. The Full directory
files are generated Sunday through Saturday and contain all existing provider or
organization directory entries. For additional information regarding the downloads,
please refer to the Directories Implementation Guide.
Important: It is required that participant vendors, at a minimum, download the nightly file to
update their records and pull a full file once per week.
3.5.1
DOWNLOADING DIRECTORIES DIRECTLY FROM ADMIN CONSOLE

Click the Directory Download button to download a directory.
Select either Prescriber or Pharmacy from the Directory drop-down.

The directory Version is automatically selected based on the user's account.
Note: EPCS is supported in 4.4 and higher. CI Messaging is supported in 4.5 and higher.
Click Get Latest Updates. Search results are displayed in the lower portion of the
screen, immediately below the Directory Download criteria.

PAGE 37
Directories
The return fields include the following:

Field
Description
Date Updated
The date the file was posted by Surescripts. This field can be sorted
ascending/descending.
File
Active link to the file.

Links are enabled for 14 days from the date posted.
"NO UPDATES" reflects no changes from the previous day.
Download Type
F = Full
N = Nightly
Version
Version number of the download that is available.
Click the Download hyperlink on the row of the update file you want and follow the
instructions for viewing or saving the file.
When the download is complete, click Close to close the window or Open to open
the ZIP file.
Note: Download times will vary based on your connection speed and the size of the directory file
being downloaded.

PAGE 38
SECTION 4
Message Search
MESSAGE SEARCH
Vendor participants can use the Message Search functionality to search for transactions
associated with their account.
Note: Depending on the message origination point, some of the CI messages may not be
available for search.
Users will be able to view messages for any transaction associated with their account,
whether they are the sender or the receiver. Results of Message Search are displayed in
descending Modification Date Time order and then by Message ID.
Message Search screen
4.1
SEARCH CRITERIA
The search criteria in the message search functionality have many of the same
properties as those of the provider and organization search windows.
The following search criteria are available.
Search Criteria
Field Name
Description
Message ID
The Message ID generated by the vendor participants application.
Type
The type of transaction, including NewRx, Refill, etc. See Section 4.1.3 Message
Type-Search Criteria.
This field supports partial matching by first letter. Type the first few characters of a field
for a smaller search list. See screen shots below.
Status
Indicates the status of a message transaction; i.e. Verify, Pending, or Error. See
Section 4.1.4 Message Status.

PAGE 39
Message Search
Field Name
Description
From Date/Time
Defaults to the day before the current date and can be modified to expand or reduce a
date range.
To Date/Time
Defaults to the current date and can be modified to expand or reduce the date range.
The time defaults to 11:59 pm. This field can be modified to expand or reduce a time
range.
Case ID
Case ID generated by the vendor participant's application for ePA processing.
Reference ID
Reference ID generated by the vendor participant's application for ePA processing.
4.1.1
MESSAGE ID - SEARCH CRITERIA

The Message ID is generated by the vendor participants software application. It is
used as a way to track or identify a message on the network. While a good piece
of information to have in the search process, it is not required to track down a
transaction. Users can use a combination of the other search fields to identify a
specific transaction and obtain the Message ID.
Note: If Message ID is used, no other search criteria are valid.
4.1.2
DATE/TIME RANGE - SEARCH CRITERIA

While these fields default to the previous and current day, you may search any
date or time range. However, transaction information is only visible for up to 90
days from the current date.
4.1.3
MESSAGE TYPE - SEARCH CRITERIA

The dropdown default is set to search for all message types; select a specific
message type to refine the search.
For more details on messages and message types, refer to the appropriate
Surescripts' guides.

PAGE 40
Message Search
Rx
CI
Directory
Routing Routing Messaging
Message Type
Description
ERROR
This transaction transmits that an error has occurred,

indicating the request was terminated. An error can be
generated when there is a communication problem or when
the transaction actually had an error (e.g. formatting
problem).
NEWRX
A request for a new prescription, which is sent from the

provider via the provider vendor to the organization of the
patients choice.
REFREQ
Sent from the organization to the provider via the provider

vendor to request a renewal for a patients prescription.
REFRES
A response to the request for a renewal (REFREQ) sent by

the provider via the provider system to indicate whether the
renewal request has been approved or denied.
RXCHG
Sent from the organization to the provider via the provider

system to request a change for a new prescription, e.g.
request the use of a generic substitute.
CHGRES
A response to the RXCHG, which is sent by the provider to

the organization indicated acceptance or denial.
RXFILL
Sent from an organization to the provider via the provider

system to notify the provider of the dispensing status of a
prescription.
RxFill, ReSupp and Census are not currently supported on
the network.
VERIFY
This transaction is used if the requestor requests an

acknowledgement. It indicates the source has received and
accepted the transaction.
CANRX
This transaction is sent by the provider via the provider

system to request that a previously sent prescription should
be canceled and not filled.
CANRES
This is a response transaction to the CANRX and is sent by

the organization to the provider indicating acceptance or
denial of the cancellation.
DirectoryDownload
A request made to Surescripts for a flat file list of

organizations or providers in the Surescripts directories.
DirectoryDownloadR
esponse
A response to the Directory Download request that includes

the name of the directory downloaded file.
AddOrganization
This is the organization vendors request to add an

organization to their account.
UpdateOrganization
A request from the organization vendor to update an

existing organization record.
Updates can be made to demographic information,
activation or deactivation of stores and maintenance of
service levels.
AddPrescriber
A request by the prescribing vendor to add a new provider

to their directory record.
UpdatePrescriber
No longer used.
AddPrescriberRespo
nse
Response sent to the provider vendor participant following

an AddProvider request. With a successful message this will
include the SPI which was automatically assigned by
Surescripts and the other values entered.

PAGE 41
Message Search
Rx
CI
Directory
Message Type
Description
AddPrescriberLocatio
n
The addition of a new location to a provider already listed in

the Surescripts directory.
UpdatePrescriberLoc
ation
Used to update provider information, including provider

name. The 13 digit SPI must be included.
If all submitted name elements do not match existing
directory information, the directory will be updated with the
new information.
AddPrescriberLocatio
nResponse
When a new location has been added successful to a

provider, the response is returned with the new Location ID
(last three digits of the 13 digit SPI) and all directory
information for the provider location.
GetPrescriber
Used to retrieve provider information based on an existing

providers SPI. Returned only if the network participant has
access to the providers record.
GetPrescriberRespon
se
Includes all directory related information for the given

provider that is stored in the Surescripts directories. The
requested information will not be returned if the requester
does not own the record.
GetOrganization
Used to retrieve organization information based on the

organization ID, NCPDP ID, or Payer ID. Information is
returned only if the network participant has access to the
organization record.
GetOrganizationResp
onse
The information contained in the message will include all

directory related information for the given organization that
is stored in the Surescripts directories. Information is only
returned if the network participant has access to the
organization record.
GetProvider
Used to search for organizations or providers based on the

identification or address information. Information is returned
only if the network participant has access to the record.
GetProviderRespons
e
Returned when 0 or more results were found that match the

given search parameters.
AddProvider
No longer used.
UpdateProvider
No longer used.
RESUPP

the network.
CENSUS

the network.
ContinuityofCareRec
ord
This is a service level for convenience clinics or providers to

send or receive a Continuity of Care Record message to or
from a provider, clinic or provider group.
MailOrder
Not used.
SetMailbox
No longer used.
IProofSM
No longer used.
ClinicalMessage
Clinical Message is sent from one provider to another.
ClinicalEvent
Response associated with a Clinical Message.
PAInitiationRequest
Prior Authorization Initiation Request
PAIntiationResponse
Prior Authorization Initiation Response
PARequest
Prior Authorization Request

X
X
PAGE 42
Message Search
Rx
CI
Directory
Message Type
Description
PAResponse
Prior Authorization Response
PACancelRequest
Prior Authorization Cancel Request
PACancelResponse
Prior Authorization Cancel Response
PAAppealRequest
Prior Authorization Appeal Request
PAAppealResponse
Prior Authorization Appeal Response
4.1.4
MESSAGE STATUS
Message Status identifies the status of the message transaction. The drop-down
default is set to All statuses and the Last Status (most recent) displays on the
Message Detail screen.
4.2
Message
Status
Description of Message Status
Sent
Surescripts transmitted message to next receiver (i.e. an aggregator or

gateway)
Pending
Surescripts is awaiting a response from the final message recipient.
FaxPending
Fax has been transmitted but no Verify received.
Mailboxed
Surescripts has successfully transmitted message to recipients mailbox.
FailurePending
Surescripts encountering communication issues but message transmission

has not timed out (no Error or Verify received).
Verified
Surescripts received confirmation of message receipt from final message

recipient.
Error
Message encountered validation or communication error.
RespondedTo
Provider has successfully responded to a REFREQ (i.e. sent REFRES).
SEARCH RESULTS
Search results are returned in the window below the Message Search criteria.
Message Search Return Fields:
Search Results
Field
Description
From
The transaction initiator.
To
The transaction recipient.
Clinic Name
Clinic associated with the provider.
Message Type
Refer to Sec. 4.1.3 Message Type for more information.
Date Time (XXX)
The date and time of the transaction. "(XXX)" represents the time zone
for which the interface is set. In example below, it is set to "CST": Central
Standard Time.
Status
Represents the most recent status of the transaction. Please note this
may not be the final status of the transaction.

PAGE 43
Search Results
Field
Description
Description
Offers an overview of the current status.
Detail
Provides the hyperlink to the message detail.
Message Search
The Search Results screen displays the first 200 messages for the Date and
Time range. To narrow the return results, update or narrow the Date and Time
Range window.
Note: The Admin Console is a replicated site of the actual transactions that are occurring on the
Surescripts network servers. As such, while a transaction may have occurred in real time,
it may take several minutes for the replicated site to display the transmission information.
4.3
MESSAGE DETAIL SCREEN

Transactions within 30 days of the current date will display message summary,
status and content details. Transactions greater than 30 days and less than 90
days of the current date will only display the summary and the Last Status (most
recent).
The Message Detail screen is comprised of three components: Message
Summary, Message Status and Message Content. Message Status and Message
Content are visible only to those who have PHI access and Last Status within the
Message Summary is also only available to those with PHI access.
4.3.1
MESSAGE SUMMARY
Within the Message Summary section, there are seven components: Header,
Sender, Receiver, Details, Last Status, Message Status, and Message Content.
Last Status is only visible to those who have PHI access. For more details about
the various component fields, please see the tables below for each of the Message
Summary components. Highlights of the Message Summary screen include:
Parens next to the section headings on this screen which indicate where
the information for each table is pulled from, e.g. (from message), (from
directory).
All related message information is directly linked to allow a quick view of
the provider, organization, account, portal, and related messages. For
example, the NCPDP ID links to the Organization Detail page and SPI
links to the Provider Detail page.

PAGE 44
Message Search
The Last Status (most recent) is displayed for quick analysis (to users
with PHI access).
CI service level users can copy and paste the Surescripts Internal ID
number from the Last Status section in the Fax Search screen to view
PDF attachments.
UTC is displayed after every date/time value. All date/time values default
to UTC unless set to local time in the user profile except for Message
Status, which always displays in UTC time.
Message Summary Section of the Message Detail Screen
Header
Field Name
Description
Message
Category:
Determined by the product family that the

message belongs to. For example, a
NEWRX is part of the e-prescribing
category.
Message Type
e.g. NEWRX, REFREQ, AddProvider,

ClinicalMessage
Routing Message Header
Yes
Message ID
Alpha numeric unique ID associated with the

transaction generated by vendor participant
application.
Yes
Relates To Msg.
ID
Alpha numeric ID: displays when applicable
Yes
Sent Time Local
Message date and time stamp displayed in

users setting of the Admin Console
interface.

adjusted for user profile
Yes
Sent Time UTC
Message date and time stamp displayed in

UTC.
Yes
Information Source
Visible w/o
PHI Access
Yes

PAGE 45
Message Search
Sender
Field Name
Description
Information Source
Visible w/o
PHI Access
Account
Account associated with the sending enduser record or profile (SPI or NCPDPID).
Surescripts Directory
Yes
Portal
Portal associated with the sender.
Yes
Name
Name associated with the sending end-user

record or profile.
Yes
SPI or NCPDP
ID
The source identifier of the sender.

The field displayed is determined by the
associated user account and the message
type.
Yes
Receiver
Field Name
Description
Information Source
Visible w/o
PHI Access
Account
Account associated with the receiving

end-user record or profile (SPI or
NCPDPID).
Yes
Portal
Portal associated with the sender.
Yes
Name
Name associated with the receiving enduser record or profile.
Yes
SPI or NCPDP ID
The source identifier of the receiver.

The field displayed is determined by the
associated user account and the message
type.
Yes
Field Name
Description
Information Source
Visible w/o
PHI Access
Provider
Provider <LastName>, <FirstName> as it

is displayed in the IncomingContent
Message Detail.
IncomingContent Message
No
Provider Phone
Provider <PhoneNumber> as it is
displayed in the IncomingContent
Message Detail.
No
Store Name
Organization <StoreName> as it is
Message Detail.
No
Store Phone
Organization Phone <Number> as it is

Message Detail.
No
Drug
<DrugDescription> as it is displayed in the

IncomingContent Message Detail.
No
Patient Name
Patient <LastName>, <FirstName> as it is

Message Detail.
No
Patient DOB
Patient <DateOfBirth> as it is displayed in

the IncomingContent Message Detail.
No
Details
The Last Status provides the most recent status received.

PAGE 46
Message Search
Last Status
Field Name
Description
Information Source
Visible w/o
PHI Access
Status
Message status. For more detail, see

Section 4.3.2 Message Status, below.
The Message
No
Date/Time
The Date/Time that the status was logged.

This will always display as UTC time.
The Message
No
Description
Description of the status
The Message
No
4.3.2
MESSAGE STATUS
The Message Status component provides an overview of the transactions
journey on the Surescripts network. A transaction can have a single status or
multiple status points. The Message Status is read from the bottom up, with the
most recent status displayed at the top of screen. See Section 4.1.4 for Message
Status details.
Within the Message Details window, the Message Status will not be visible unless
the user has PHI access. For users without PHI access, please refer to Section
4.3.2.3 Viewing Message Status Details in Search Results.
Note: The time displayed in a Message Status is Universal Time Coordinated (UTC), not what the
user may have their interface time set to. Within the Message Summary Header, both
local and UTC times are displayed.
4.3.2.1 MESSAGE TRANSMISSION PROTOCOL

Each electronic message transaction is attempted four times across the network.
These intervals normally occur:
Immediately
After 1 minute
After 5 minutes
After 10 minutes
If an electronic transaction is unsuccessful after the fourth attempt, Surescripts will

roll the transaction over to Fax and send in intervals of 3-5 minutes, with a
maximum of eight delivery attempts. If the transmission fails to transmit via Fax, an
Error will be returned to the sender.

PAGE 47
Message Search
pharmacies certified for controlled substances (EPCS).
4.3.2.2 FAXABLE ERROR MESSAGE

A Faxable Error Message (FEM) occurs when a transaction experiences a
communication error. In these cases, Surescripts will validate the transaction
against its Fax template specifications and, based on acceptance by the
specifications, will generate a PDF Fax and forward to the receiver.
pharmacies certified for controlled substances (EPCS).
4.3.2.3 VIEWING MESSAGE STATUS DETAILS IN SEARCH RESULTS

Users without PHI access can view full message status details in the Message
Search Results window. Message Status details do not contain PHI. To view
Status details, place your cursor over the detail link and a pop-up box will display
the Status of the transaction. The Status is reviewed in the same manner as within
the Message Details option from the bottom up. To close the pop-up box, click
the Close link.
4.3.3
MESSAGE CONTENT DETAIL

Only users with PHI access will have visibility to this information. When a
transaction is received on the Surescripts network, it is captured and displayed
within the Message Detail three times:
Message Content
Detail
Description
IncomingContent
Message
Message content transmitted to Surescripts by sender (can be XML,

EDIFACT, or HL7).
This is the message as it came into Surescripts with no manipulation of
the data by Surescripts.
MessengerXML
Message
XML translation of incoming message content. Utilized for Surescripts

validation.
OutgoingContent
Message
Message content transmitted from Surescripts to recipient (can be XML,

EDIFACT, or HL7).
Prescription Routing message formats include XML or EDIFACT; the message

format is dictated by the vendor participants application. Surescripts acts as a
bridge between the message formats to facilitate the transactions.
The XML format includes tags around each field element. An example of XML
formatting is displayed below.

PAGE 48
Message Search
The EDIFACT format separates fields with a delimiter, e.g. :(colon). The following
is an example of the EDIFACT format.
Best Practice: For assistance in troubleshooting message content issues, it can be useful to
have reference documents, such as the respective XML and EDIFACT
Implementation Guides, to assist in understanding specific fields required and
used on the Surescripts network.

PAGE 49
Message Search
The Select All icon, found at the top left of each XML Content section, when clicked
will select all of the text within the text box. Select the clipboard icon to place the
contents of the screen onto the clipboard for a quick Copy-Paste function (to copy to
a file or XML validator, for example).
4.3.3.1 MESSENGERXML MESSAGE (VALIDATION)

In order to ensure that all transactions meet NCPDP/Implementation Guide
Standards, the MessengerXML syntax validation is applied prior to forwarding any
transaction to a receiving party. Should a transaction fail validation, the FEM
(Faxable Error Message) process will attempt to validate and send the transaction
as a fax. If a transaction fails both validations, an Error message will be returned to
the sender.
4.3.3.2 MESSAGE DETAIL SUPPORT FOR LARGE CLINICAL MESSAGES
To optimize the performance of the Message Detail screen, attachments are
removed from the Message Content XML sections of Clinical Messages.

PAGE 50
SECTION 5
Message Search (Medication History Message)
MESSAGE SEARCH -MEDHISTORY

MESSAGE
Within the Surescripts network there are two connections available to vendor participants to
conduct medication history transactions. With the implementation of NCPDP Version 10.6,
vendor participants will connect through the one Surescripts network. Those transactions
will not be viewable within the Admin Console. For assistance with researching medication
history transactions over the Surescripts network please contact Surescripts Customer Care.
Vendor participants that have not ransitioned to 10.6 are still able to view Medication History
message transactions in the Admin Console. To view, click on the Med Hist Msg Search
button. The Search for Message Display screen appears. This screen includes the same
searchable criteria as the Message Search as presented in Section 4 Message Search;
however, the available Message Types will be specific to Med History transactions.
5.1
MEDICATION HISTORY MESSAGE TYPE

The dropdown default is set to all message types. Only request message types
(XXXREQ) are available for research at this time. The resulting response
messages (XXXRES) are appended to the original request message detail; the
response transactions cannot be searched individually.
Message Type
Description
ELGREQ
No longer used.
RXHREQ
Medication History Request the transaction request for the medication history of a patient.

PAGE 51
Message Search (Medication History Message)

PAGE 52
SECTION 6
Report Log
REPORT LOG
Each month Surescripts will post to its participant vendors a series of standard reports
designed to overview the previous months activity and metrics. Reports are available for up
to 90 days, after which they are available by request from Surescripts Customer Care.
Not all reports may be available to all vendor participants and some custom reports are
available. Please contact your account manager to discuss options for customizing a report.
To access reports, click on the Report Log button. Reports can be either opened for
viewing or downloaded for future reference.
6.1
PROVIDER REPORTS
Provider Detail Report
This Excel data file includes three worksheets with aggregate information:
transaction volume summary by State, provider activity summary, and a byprovider overview of transactions.
Provider Transaction Report
This text file lists each transaction associated with providers of the account.
Information is at a high level and includes NCPDPID, SPI, Message Type, Date
and Time of the transaction, and the customers Message ID.
Provider Monthly Report Card
This Excel file aggregates activity for the provider vendor and summarizes
directory and transaction metrics.
Provider Support Report
(Future Report) An Excel data file which overviews cases reported to and sent to
the participant vendor for the previous month.
6.2
ORGANIZATION REPORTS
Organization Transaction Report
This text file lists each transaction associated with organizations of the account.
Information is at a high level and includes NCPDPID, SPI, Message Type, Date
and Time of the Transaction, and the customers Message ID.

PAGE 53
Report Log
Organization Monthly (Activity Report)

This PDF file aggregates activity for account transactions.
NEWRX2REFREQ Report
This report is designed to identify for organizations the ratio of incoming NewRx to
the RefillRenewal Requests generated to a specific provider. Inclusion on this
report may identify issues with generating electronic refill requests to a provider.
Organization Monthly Analysis Report
This report provides a three month trend review of transaction and network-related
analysis.

PAGE 54
SECTION 7
PDMP
PDMP
The Medication History search screens allow pharmacy users to correct errors for which
were identified during the PDMP edit process. The pharmacy user may only edit data which
is associated with their pharmacy. Only prescription records which were marked as in error
will be eligible to be edited.
7.1
SEARCH CRITERIA
Search Field Qualifiers
Qualifier
Description
Required field.
Exactly matched. The field must contain an exact match of information.
Any combination of fields may be used to conduct a search.
7.2
MEDICATION HISTORY SEARCH

Medication History Search Screen Functionality
To manually search and modify a medication history prescription record, click on
the PDMP menu option within the Support section. The following fields can be
used for search criteria:
Field Name
Description
Search Qualifier:
* (required)/
E(exact)
Fill Date From
Date range used to retrieve prescriptions based on the date

the prescription was filled by the pharmacy. The Fill Date From
is the earliest inclusive date which will be used in the search.
Required
Fill Date To
Date range used to retrieve prescriptions based on the date

the prescription was filled by the pharmacy. The Fill Date To is
the latest inclusive date which will be used in the search.
Reporting State
Choice of valid US States where the Pharmacy is located.
Prescription #
Number printed on the prescription bottle by the pharmacy.
Only Error
Records
Only Error checkbox. When selected, only error records will be

returned.
Division
Pharmacy type which the prescription record belongs to.

Choices include Retail, Mail Order, Specialty, Long Term Care
and Infusion.
Error Severity
Error Status level used to categorize the error. Choices include

Fatal, Severe, and Minor.

Exact
PAGE 55
Select the Search

Select the Reset
7.2.1
PDMP
button to search available records.

button to clear and begin a new search.
PDMP SEARCH RESULTS

Search results are returned in a window below the Medication History Search
criteria. The records will be returned and sorted by Fill Date, Prescription Date,
Patient State and Prescription number. Only the first 500 records will be returned.
The returned fields include the following:
Field
Description
Fill Date
The date the prescription was filled by the pharmacy.
Rx State
U.S. State where the prescription was filled.
Patient State
U.S. State where the patient resides.
Division
Division/Pharmacy type which the prescription record belongs.
Rx #
Number printed on the prescription bottle by the pharmacy.
Fill #
Sequential number associated with the number of times the prescription

has been filled.
00=Original fill
01=1st refill, etc.
Store #
The identifier for the pharmacy store that filled the prescription, when
provided by the pharmacy in the Medication History load file.
NCPDP ID
Unique national provider Identifier. Formerly known as the NABP number.
Status
The status for the medication record which will include values: Error, Error
Free, Exclude by User, and Override.
Error Severity
Error Status level used to categorize the error.
Error Field
Name of the field in error, when applicable. An asterisk (*) will designate
when more than one error exists for the medication.
Error Message
The description of the error(s), when applicable.

PAGE 56
7.2.2
PDMP
RECORD DETAILS
The record detail is accessed when you click on the Edit link, located on the far
right of each record within the Search Results screen.
The segment field tables below list the fields along with a brief description. The
data is grouped and presented in segments by Patient, Pharmacy, Prescriber,
Medication, Plan, Other, and Compound Ingredients information. For more
information, please refer to the current version of the Surescripts Medication
History for Pharmacies Implementation Guide.
The data within each segment may be expanded or collapsed as desired by
selecting the plus (+) or minus (-) icon for each segment.
The export function allows the pharmacy user to save data to an external
spreadsheet. This allows the arrangement of the content based on the specific
needs of the participant, as well as the option to work offline outside of the Admin
Console while researching errors.
Note: Browser prompts will vary depending on the browser used and individual preference setup.
Screen Controls
The following screen controls may be used for the Record Details screen.
Control
IE 9 Hot Keys
Description
Save
Alt + S
Saves the record to the database, but only if no errors exist.
Next
Alt + N
Displays the next medication history record which has been marked
as in error.
Return to
Search
Alt + R
Returns the user to the search screen.
Override
Alt + O
Allows the pharmacy user to indicate the medication history record

should be reported as is to one or more PDMP state programs.
Exclude
Alt + L
Allows the pharmacy user to indicate the medication history record

should NOT be reported to any PDMP state programs.

PAGE 57
PDMP
Patient Segment Fields

Field Name
Field Description
Pharmacy Patient ID
Unique patient identifier assigned by the pharmacy. Display only.
Alternate Patient ID
Qualifier
Qualifier used for identifying the type of ID the patient provides to the
pharmacy.
Alternate Patient ID
Unique identifier as issued by governmental issuing authority and provided

to the pharmacy for identification.
Customer DL Number
Free form text field for the patients Drivers License number.
Patient Location Code
Code associated with the location where the patient resides (e.g. Home,
Nursing Home, Long Term Care, Hospice, etc.)
Patient Last Name
Last name of the patient. Display only.
Patient First Name
First name of the patient.
Patient Middle Name
Middle name of the patient.
Patient Prefix
Prefix for the patient (e.g. Dr., Mr. Ms. Etc.). Display only.
Patient Suffix
Suffix for the patient (e.g. Jr., Sr., III, etc.)
Date of Birth
Patients date of birth in MM/DD/YYYY format.
Patient Gender
Sex of the patient (e.g. Male, Female)
Patient Phone Number
Patients contact phone number (e.g. home phone, cell phone, etc.).
Patient Address 1
Patients home address.
Patient Address 2
Patients additional address info (e.g. Apartment 123).
Patient City
Patients home city. Display only.
Patient State
Patients home state. Select U.S. state from the drop-down list. This field is
updatable.
Patient ZIP Code
Patients US ZIP code.
Country of Non-US
Resident
For non-US residents only. Patients country of residence.
Patient Active Indicator
Valid values:
0=Patient is active and medication information can be shared
1=Patient has requested that none of their information be shared. No
medication information for this patient will be shared.
Drug Record Indicator
Valid values:
0=Medication information can be shared
1=Patient has requested that only this medication record not be shared.
Allergy
Allergy text information which may be included on the prescription bottle.
Diagnosis Code
Qualifier
Qualifier associated with the diagnosis code.

Valid values:
01=ICD-9 CM
02=ICD-10 CM
03=Other
Diagnosis Code
Diagnosis code specified by the prescriber.
Species Code
Code indicating if the prescription is for a human or veterinarian patient.
Name of Animal
Name of animal for which veterinarian has written the prescription.

PAGE 58
PDMP
Patient Segment Fields
Pharmacy Segment Fields

Field Name
Field Description
NCPDP ID
Unique national provider Identifier. Formerly known as the NABP

number.
Pharmacy Type
Division/Pharmacy type which the prescription record belongs.
Pharmacy Name
Name of the pharmacy that filled the prescription.
Rx Origin Code
Code indicating origin of prescription.

Valid values:
00=Not Specified
01=Written Rx
02=Telephone Rx
03=Emergency Phone
04=FAX
05=Electronic
99=Other
Pharmacy DEA
Drug Enforcement Administrations unique identifier for the Pharmacy. 2

alpha chars followed by 7 digits
Pharmacy DEA Suffix
Identifying number assigned to a pharmacy when the DEA number of the

institution is used.
Pharmacy NPI
10 Digit unique National Provider ID associated with the pharmacy.
Pharmacy Address 1
Pharmacy store address.
Pharmacy Address 2
Pharmacy store additional address information.
Pharmacy City
City where the pharmacy store is located.
Pharmacy State
State where the pharmacy store is located.
Pharmacy Zip Code
ZIP code where the pharmacy store is located.
Pharmacy Phone Number
Pharmacy stores phone number.
Contact Name
Pharmacy contact name.
Pharmacist NPI
10 Digit unique National Provider ID associated with the pharmacist.
Pharmacist Last Name
Pharmacists last name.
Pharmacist First Name
Pharmacists first name.
Pharmacist Middle Name
Pharmacists middle name.
Pharmacist State License
Pharmacists state license number.

PAGE 59
PDMP
Field Name
Field Description
State Code Issuing Rx

Serial Number
State code that issued serialized prescription blank.
State Issued Rx Serial

Number
Number assigned to state issued serialized prescription blank.
Pharmacy Board License

Number
Board of Pharmacy License Number.
Pharmacy Alternate
License Number
Used when additional license numbers exist (e.g. State defined license
numbers).
Chain Site ID
The Pharmacy Store number (internal to the pharmacy chain)
Segment Fields
Prescriber Segment Fields

Field Name
Field Description
Prescriber SPI
Surescripts Prescriber Identifier
Prescriber NPI
10 Digit unique National Provider ID associated with the prescriber.
Alternate Prescriber ID
Used when more than one prescriber ID is available.
Prescriber DEA Number
Drug Enforcement Administrations unique identifier for the prescriber. 2

alpha chars followed by 7 digits.
Prescriber DEA Suffix
Identifying number assigned to a prescriber when the DEA number of

the institution is used.
State License Number
Prescribers license number issued by the state.
Prescriber Last Name
Prescribers last name.
Prescriber First Name
Prescribers first name.
Prescriber Middle Name
Prescribers middle name.
Prescriber Prefix
Prefix for the prescriber (e.g. Dr., Mr. Ms. Etc.). Display only.
Prescriber Suffix
Suffix for the prescriber (e.g. Jr., Sr., III, etc.)
Prescriber Address 1
Prescribers office address.
Prescriber Address 2
Prescribers additional office address information.
Prescriber City
Prescribers office city.
Prescriber State
Prescribers office state.
Prescriber ZIP Code
Prescribers office ZIP code.
Prescriber Phone Number
Prescribers office phone number.
Prescriber Fax Number
Prescribers office fax number.

PAGE 60
PDMP
Prescriber Segment within the Medication History Detail
Medication Segment Fields

Field Description
Field Name
Prescription Number
Serial number assigned to the prescription by the pharmacy. Display

only.
Fill Number
Date the prescription was filled by the pharmacy. Display only.
Drug Class
Classification level for controlled substance drugs (Schedule I V).
NDC Number Dispensed
National Drug Code universal product identifier for human drugs.
Medication Name
Short Drug or Label Name.
Quantity Prescribed
Metric units prescribed by the prescriber.
Quantity Dispensed
Metric units dispensed to the patient.
Qualifier Units of Measure
Unit of measure code.
Days Supply
Number of days of the prescription.
Date Written
Date the prescription was written.
Date Adjudicated
Not used for PDMP reporting.
Date Filled
Date the prescription was filled by the pharmacy.
Date Picked Up
Date the patient picked up the prescription from the pharmacy.
Refills Originally Authorized
Number of refills the prescriber initially authorized.
Refills Remaining
Number of refills which may still be filled.
Partial Fill Indicator
Valid values:
01=Prescriptions which represent a partial fill
02=Prescription that is not a partial fill.
RxNorm Code Product

Qualifier
RxNorm Code
Identifies the type of RxNorm Code.
Partial Fill Indicator
Identifies if the prescription was partially filled

Valid values:
01-Partial Fill
02-Not Partial Fill
Electronic Rx Number
For electronic prescriptions; used to provide an audit trail.
SIG Text
Text directions for how to use the medication.
For electronic prescriptions; used to capture the prescribed drug product

identification.

PAGE 61
PDMP
Medication Segment
Plan Information Segment Fields

Field Name
Field Description
Plan Code
Type of payment plan.

Valid values:
01=Private Pay
02=Medicaid
03=Medicare
04=Commercial PBM Insurance
05=Major Medical
06=Workers' Compensation.
Payment Code
Method used to pay for the prescription.

Valid values:
01=Private Pay (Cash, Charge, Credit Card)
02=Medicaid
03=Medicare
04=Commercial Insurance
05=Military Installations and VA
06=Workers' Compensation
07=Indian Nations
99=Other.
BIN
Bank identification number used to identify the state agency to which

information is transmitted.
PCN
Not used for PDMP reporting.
Group ID
Insured members group plan ID. Not used for PDMP reporting.
Cardholder
Number
Insured members cardholder number. Not used for PDMP reporting.
Plan Information Segment within the Medication History Detail

PAGE 62
PDMP
Other Segment Fields

Field Name
Field Description
Drop Off/Pick Up Qualifier
Identify whether the person is dropping off the prescription or picking up

the medication.
Drop Off/Pick Up Issuing

Jurisdiction
Code identifying jurisdiction that issues ID in the Drop Off/Pick Up

Person ID field
Drop Off/Pick Up Person ID

Qualifier
Used to identify type of ID in the Drop Off/Pick Up Person ID field.

Valid values:
01=Military ID
02=State Issued ID
03=Unique System ID
04=Permanent Resident Card
05=Passport ID
06=Drivers License ID
07=Social Security Number
08=Tribal ID
99=Other (Trading partner agreed upon ID)
Drop Off/Pick Up Person ID
ID of person dropping off or picking up Rx
Drop Off/Pick Up Person

Relationship
Relationship of person dropping off or picking up Rx.

Valid values:
01=Patient
02=Parent/Legal Guardian
03=Spouse
04=Caregiver
99=Other
Drop Off/Pick Up Last Name
Last name of Person dropping off or picking up the prescription.
Pick Up First Name
First name of Person dropping off or picking up the prescription.
Message
Free-form text message. Used for more detailed information if required

by a PDMP state.
Other Segment within the Medication History Detail
Compound Ingredient Segment Fields

Field Name
Field Description
Sequence
Sequential sequence number for each ingredient. Incrementing for each

ingredient which comprises the compound drug
NDC Number
NDC Code for the ingredient
Name
Short drug or label name for the ingredient.
Quantity
Metric unit of the ingredient.
Unite of Measure
Unit of measure code for the ingredient.

PAGE 63
PDMP
Field Name
Field Description
Drug Schedule
Drug classification level for the ingredient.

1 = Schedule I
2 = Schedule II, etc.
Compound Ingredient Segment within the Medication History Detail

PAGE 64
SECTION 8
Support Case Management (Self-Service Portal)
SUPPORT CASE MANAGEMENT

(SELF-SERVICE PORTAL)
The Surescripts Self-Service Portal provides a centralized process for case management.
Vendor participants who connect directly to the Surescripts network will use the self-service
portal to log and manage support-related cases and issues.
Vendor participants who connect to the Surescripts network through a gateway aggregator
vendor will use support protocols as identified by their vendor.
Participant vendors may have an integration component applied to their Admin Console
account that will enable them to log and manage, on a limited basis, support-related cases.
This integration will link their Self-Service Portal account with their Admin Console account.
To determine whether or not a vendor account has access, check the left menu bar for the
Case Management button. If the Case Management button is not present and the vendor
participant is a direct-connect to the Surescripts network, the participant should contact
Surescripts Customer Care for assistance in establishing the link.
There are two ways to log a case within the Admin Console: through the Case
Management menu item, or through the details of a provider/organization/message detail
record.
8.1
CASE MANAGEMENT LINK

Click on Case Management in the left menu. The Active window will display a
New Case link and a date range to search for open or closed cases through the
Admin Console.
To create a new case, click on the New Case button to display the support case
template.

PAGE 65
Note: Patient PHI (Protected Healthcare Information) is not permitted within the case details in the
Self-Service Portal or the Admin Console.
Complete the appropriate fields to highlight information to support the case. As

with the Self-Service Portal, some fields have a red asterisk (*) and must be
included to successfully submit the case. Where provided, be sure to indicate the
appropriate case type and priority you wish to assign to the case.
8.1.1
Drop-down Option
Description
Case Category
Select the case category which best represents your inquiry:

For Example:
- Admin (Admin Console, Acct Contacts, Password Resets)
- Provider Update Request (Complete Section D)
- Retail
- Mail Order
- Medication History
Type
Select the case type which best represents your inquiry:

For Example:
- Acute Medication History
- Administrative
- Ambulatory Medication History
- Directories
Case Initial Reason
Some of the Case Category/Type combinations require an initial reason to

be populated as well.
Priority
Severity 3 = Minor impact

Severity 2 = Moderate impact
Severity 1 = Use sparingly**
**Severity 1 cases are reserved for outages and potential patient safety
issue (PPSI) instances only.
Email
Contact information for Surescripts support to use in follow-up questions.
User Call Back Phone
Phone number of the user reporting the issue.
CASE MANAGEMENT
Managing cases from the Admin Console is limited to only those cases created
within the Admin Console interface. Cases created in the account-holders SelfService Portal interface will not be visible in the Admin Console.

PAGE 66
To view all cases for an account, you must utilize the Self-Service Portal interface.
To view cases created in the Admin Console, click on Case Management in the
left menu and set the date range under the New Case link. By default, open cases
will display. Click the Closed Cases Only check-box to display cases created in
the Admin Console which have since been resolved and closed.
To access case details, click on the Case Number link. The case details will
appear including any attachments or comments that have been appended to the
case. The user can add case comments and attachments as needed.
Important Note: If attaching a document that contains PHI, the user must first password protect
and encrypt the document to ensure the patient information is not exposed.
Once uploaded the user should contact Surescripts Customer Care to provide
the associated password.
8.2
CASE CREATION USING RECORD DETAILS

Within the provider and organization record details, click the Open a Support
Case link.
To create a case from a specific message detail, click the Create Support Case
link. The resulting window (shown below) will be similar to the new case window as
described in Section 8.1. Specific information on the provider, organization, or
message details will pre-populate the form. All other steps in completing and
transmitting the case apply.

PAGE 67
To manage a case, refer to Section 8.1.1 Case Management.
8.3
ACCESSING SUPPORT SOLUTIONS

As within the Self-Service Portal, the Admin Console Case Management
Integration feature does provide access to the Surescripts Knowledge Base
(Surescripts Solutions).

PAGE 68
Note: The links to the solutions are read-only and non-interactive; whereas documents are
available for download in the Self-Service Portal, they are not available for download in the
Admin Console view.
Click the Access Support Solutions link within the support case template window
and the Surescripts Admin Console Support Solutions window opens.
The various sub-categories listed can be reviewed for appropriate issue resolution
listings. Click on the appropriate subject link to provide the details of the solution
you seek.

PAGE 69

Admin Console User Guide 2013-12-06

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Admin Console User Guide 2013-12-06

Uploaded by

Copyright:

Available Formats

ADMIN CONSOLE USER GUIDE

Date: December 6, 2013

ADMIN CONSOLE USER GUIDE

Document Change Log

Last published on 10/24/2012.

Added "clinical message transactions" and deleted "eligibility" from the

Deleted eligibility as it is not one of the options listed here.

Accounts and Portals

Updated the production and staging links to the Admin Console.

Main Screen View

Welcome screen changed to Notices screen. Added information regarding

Added screen shot of Change Password screen.

Clarified the 2 paragraph by replacing "participants" with "common

Added "or Include Active" to checkboxes in the 2nd paragraph.

Added detail to explain the search function for organization as opposed to

Fax Portal State

Fax Portal State

"Activated" to "Include Active Organizations"

LAST PUBLISHED 12/6/13

Changed "Pharmacy Name" to "Name" - Added details to the Name

COPYRIGHT 2013 BY SURESCRIPTS, LLC,

Added "Org ID" field and description

Added "Parent Org" and description

Added the fields:

Added new table, "Additional Fields of Note:"

Updated the description of the Nightly and Full download files.

Updated the Note regarding versions.

Added note regarding availability of CI messages for search.

- Removed the field qualifiers table.

- RXFILL Added "Currently not supported by Surescripts' processing."

Added Message Status and Message Content to the list of components in

Added to the description for IncomingContentMessage.

Message Search MedHistory Message

Changed section name from "Message Search Medication History

Changed description for ELGREQ to "No longer used".

LAST PUBLISHED 12/6/13

COPYRIGHT 2013 BY SURESCRIPTS, LLC,

- Case Category moved to top of fields table.

Case Creation Using

Updated the link name for creating a Case.

LAST PUBLISHED 12/6/13

COPYRIGHT 2013 BY SURESCRIPTS, LLC,

This page intentionally left blank.

LAST PUBLISHED 12/6/13

COPYRIGHT 2013 BY SURESCRIPTS, LLC,

Surescripts Admin Console Guide

About This Guide .................................................................................................... 9

User Administration .................................................................................... 13

Accounts and Portals Setup .................................................................................. 13

Search Criteria ...................................................................................................... 19

Message Search ........................................................................................ 39

Search Criteria ...................................................................................................... 39

LAST PUBLISHED 12/6/13

COPYRIGHT 2013 BY SURESCRIPTS, LLC,

Surescripts Admin Console Guide

Message Type - Search Criteria............................................................................. 40

Message Search -MedHistory Message ..................................................... 51

Medication History Message Type ......................................................................... 51

Report Log ................................................................................................. 53

Search Criteria ......................................................................................................55

Support Case Management (Self-Service Portal) ....................................... 65

Case Management Link .........................................................................................65

LAST PUBLISHED 12/6/13

COPYRIGHT 2013 BY SURESCRIPTS, LLC,