Integration and Production

the following section defines technical and support elements needed to achieve certification to move xdr based messaging into production, along with our integration, compliance, and certification processes integration process when a customer begins integrating a surescripts product into their application(s), they will be provided access to all the surescripts documentation pertaining to the product being implemented in addition, customers will be provided access to the staging environment to design, develop and test the product integration within their application note the time frame of the project can vary depending on the customer's resource allocation for the project meeting requirements during integration, customers will ensure their system has met all product requirements the certification testing will focus on message format, application workflow and display in accordance with surescripts documentation and the associated application certification requirements (acrs) for requirements, consider the following surescripts acrs are required to be met to achieve production status on the surescripts network and will be enforced as part of certification to ensure high quality transactions, surescripts applies additional business rules above and beyond the ncpdp schema defined requirements that will cause a message to be successful or rejected surescripts test cases do not cover all possible scenarios in production customers are responsible for testing any other applicable scenarios specific to their production environment in accordance with the customer’s legal agreement with surescripts, each customer is responsible for ensuring compliance with all applicable laws including, but not limited to, local and state laws/regulations where doing business upon successful completion of certification and, when applicable, other pre production network requirements (e g , identity proofing, attestations, dea audit), customers will be enabled in production transition to production once message validation testing is complete and the contract is approved by the surescripts certification review board, the customer is ready to move into production surescripts will configure the production connection and ensure successful operations with the customer prior to transition into production, surescripts account management will work with the customer and internal surescripts teams to review the following items production support contacts to be captured in an escalation matrix—a tool that specifies how surescripts should contact customers for support needs, including case routing and escalation paths support process and training support hours note the escalation matrix for use by surescripts customers can be found in the surescripts network operations guide surescripts terminology usage the following table outlines terminology usage for this guide term term usage must requirements that are enforced as part of the production code or by surescripts business rules some business rules reside in the element details section of this guide shall the requirements customers are required to meet in order to be certified on the surescripts network these requirements will be enforced as part of certification, not through business rules should used for guidance and best practices to produce superior results and enhance electronic messaging best practices can also be found in the best practice sections customers are encouraged, but not required, to meet best practices in order to be certified on the surescripts network c ### designates a surescripts clinical direct messaging acr communication rules please refer to the connectivity and authentication guide for details regarding communication and security protocol requirements as well as references to all links and ip addresses associated with surescripts services for the network to be reliable, there are communication rules to which all customers must adhere connectivity and mutual tls (mtls) surescripts requires mutual transport layer security (mtls) authentication for xdr mutual authentication means both parties in the connection authenticate each other the client authenticates the server, and the server authenticates the client mtls is standard across surescripts products and is a common source of setup issues, so the direction specific roles are described below the complete certificate and connectivity requirements are maintained in the connectivity and authentication guide, which is the authoritative source and must be followed for implementation for xdr, mtls applies in both directions of exchange, and the customer's role differs by direction when the customer sends to surescripts (customer initiated), the customer acts as the client and presents a surescripts authorized client certificate surescripts signs this certificate from a certificate signing request (csr) the customer submits see the connectivity and authentication guide, authentication section, "customer client side certificates," for the csr and client certificate requirements when the customer receives from surescripts (surescripts initiated), the customer acts as the server and presents a server certificate that surescripts validates see the connectivity and authentication guide, authentication section, "customer server side certificates," for the server certificate requirements because xdr connections authenticate with mtls, they do not require ip allow listing note the tls protocol version, cipher requirements, certificate specifications (including key length, subject fields, and acceptable certificate authorities), certificate renewal, and ip address handling are all governed by the connectivity and authentication guide refer to that guide rather than assuming any value message size the maximum size for a single xdr message, including all attachments, is 20 mb a message larger than 20 mb is rejected at the transport channel before any xdr processing occurs, so the sender receives a transport level failure rather than an xdr application level error (see xdr based messaging errors docid 6daoszcli671qovlxx3ud ) 20 mb is also the practical ceiling for broad interoperability, because not all systems in the exchange ecosystem accept messages at or near that size where a recipient’s capacity is unknown, design for smaller messages timeouts for timeouts, consider the following when sending a message to surescripts, the initiator should set the hypertext transfer protocol (http) timeout to no less than 30 seconds a receiving system must return a valid synchronous response a provide and register document set b response indicating success, or an error response within 24 seconds setting the sender's timeout to at least 30 seconds allows the receiving system adequate time to generate its response within the required 24 seconds when a message is accepted for delivery but its final delivery status is not yet known, a delivery status notification (dsn) is expected to follow if a follow up dsn is not received within 60 minutes, the message times out and surescripts generates a dsn failure to the sender note see message notifications and tracking docid\ daga7uw8atariylz3rtu9 for how synchronous responses and dsns work together utc time format by using coordinated universal time (utc), the receiver of a message will know the time regardless of their time zone for example, if a message was sent from boston at 5 30 pm edt (eastern daylight time), the time would be sent as 21 30 utc if this message was received in chicago cdt (central daylight time), the 21 30 utc could be converted to the local cdt time of 4 30 pm utc time must be synchronized with the national institute of standards and technology (nist), and the difference must be less than one minute when sending only a date (not date and time), it should be sent in the local time zone, and the receiver should interpret it in their local time neither party should attempt to convert the date to utc the format of date/time fields in the xml schema must use the xsd\ datetime format ccyy mm ddthh\ mm\ ss fz , where the utc time zone may be specified as z, +00 00 , or 00 00 for example, 2026 01 15t16 09 04 5z represents 16 hours, 09 minutes, 04 seconds, and 5 fractional seconds the fractional seconds portion is not required for simple date fields that do not include the time portion, the format is ccyy mm dd character set the character set contains ascii values 32 – 126, which includes symbols ! " # $ % & ' ( ) + , / ; < = > ? @ \[ \ ] ^ ` { | } numerals 0 to 9 letters, upper and lower case a to z, a to z utf 8 is the required character encoding for xml other encoding formats are not supported by surescripts surescripts recommends that customers declare their utf 8 formatting in the message header xml escape characters xml uses certain characters to describe the structure of the document when an element value needs to include one of these special characters, the character must be replaced with its predefined entity representation the quote and apostrophe only need to be escaped when used in an attribute most xml processor libraries handle this replacement automatically character character name xml escape " quote \&quot; ' apostrophe \&apos; & ampersand \&amp; < less than \&lt; > greater than \&gt; note string lengths are calculated based on the un escaped value for example, >98 degrees is encoded as \&gt;98 degrees but is counted as a string length of 11, not 14 compliance the goal of surescripts is efficiency and consistency across the network so all customers can meet the highest measures of patient safety, end to end reliability, and quality to ensure that customers comply with and adhere to the approved certification requirements, surescripts monitors customers in production to ensure all network customers remain in compliance with certification requirements and contractual terms initiates a remediation process for identified compliance issues to ensure network and patient safety, customer agrees to notify surescripts of any modifications through use of the surescripts recertification form upon receipt of this form, changes will be reviewed, and a determination made as to what (if any) level of certification may be required before being placed into production when changes are made to a customer’s implementation, the customer should advise their account manager the customer will be given a recertification guide to provide details regarding the changes made upon receipt of the completed document, the details will be reviewed, and a determination will be made as to what (if any) level of recertification is necessary as a reminder, surescripts conducts certification with customers to ensure the application adheres to network requirements surescripts will enforce mandatory fields as required by the standards body and surescripts guide requirements to maximize interoperability, customers are recommended to support optional fields that have been created to address gaps in discrete data needs and the many solutions that are in place for the benefit of the receiver surescripts encourages, but does not guarantee, the use of optional discrete fields to support end user workflows this guide is intended for certification on our network only and is not intended to ensure compliance with state and federal law in accordance with the customer’s legal agreement with surescripts, each customer is responsible for conducting its own due diligence to ensure compliance with all applicable laws and requirements, including, but not limited to, local and state laws and regulations in which the customer’s application is deployed and used