Message Header Elements
Message Header Elements
Element | Codes | Comment |
|---|---|---|
To | mandatory | This field will contain the NCPDPID of the pharmacy or the SPI (Surescripts Prescriber ID) of the prescriber. Note: All response messages and free standing messages should be sent to the same sender that initiated the original message. |
@Qualifier | conditional | business rule If the To field is sent, then the Qualifier must also be sent. Values: D = Prescriber ID (Used for SPI) P = Pharmacy NCPDPID |
From | mandatory | This field will contain the NCPDPID of the pharmacy or the SPI (Surescripts Prescriber ID) of the prescriber. |
@Qualifier | conditional | business rule If the From field is sent, then the Qualifier must also be sent. Values: D = Prescriber ID (Used for SPI) P = Pharmacy NCPDPID |
MessageID | mandatory | S.205: The sender shall ensure the combination of the From and MessageID elements, for all messages including Error, is unique for at least 18 months. Surescripts recommends an unformatted Globally Unique Identifier (GUID). |
RelatesToMessageID | conditional | Send the RelatesToMessageID when the most recent and relevant message in the workflow contains a MessageID. If a NewRx is sent following a BenefitResponse message, populate the RelatesToMessageID with the MessageID from the response message. See Message LinkageMessage Linkage section for more details. |
SentTime | mandatory | Date of the transmission. Please see UTC Time FormatUTC Time Format section. |
Security | conditional | |
UsernameToken | conditional | For Mailboxing, UsernameToken is used. Please refer to the Surescripts Mailboxing Guide for more information. |
Sender | conditional | |
TertiaryIdentification | conditional | Surescripts populates the Account ID associated with the sender. |
Receiver | conditional | |
TertiaryIdentification | conditional | Surescripts populates the Account ID associated with the receiver. |
MessageIndicatorFlag | conditional | business rule Indicates to the receiver that they are not receiving the original message, but rather a copy for a specific purpose. Messages sent with MessageIndicatorFlag must be sent to a receiver on NCPDP Script version V2023011 or later. This field is not backwards compatible and will be rejected by Surescripts if sent to a recipient on SCRIPT V2017071. Values:
|
DigitalSignature | conditional | If used, either send values under Actual Digital Signature or the DigitalSignatureIndicator value. |
@Version | mandatory | Version 1.1 should be used. |
(Actual Digital Signature) | conditional | Repeats 1..2. |
DigestMethod | mandatory | Values: SHA-1 SHA-256 |
DigestValue | mandatory | |
SignatureValue | mandatory | |
X509Data | mandatory | |
DigitalSignatureIndicator | conditional | Indicates if the prescription has been digitally signed. Values: true false Note: Surescripts recommends only sending this when the value is “true.” |
PrescriberOrderGroup | conditional | |
RxReferenceOrderGroup | conditional | |