Receive an E2B Transmission

Vault Safety supports receiving E2B(R2) and (R3) files from AS2 Gateway trading partners or through the Vault API.

Sections in This Article

Receiving E2B Transmissions

When Vault Safety receives an E2B transmission, the system imports the E2B file and automatically creates an AER or Inbox Item for each case in the E2B file.

Tip By default, E2B transmissions are imported as AERs unless the Transmission Profile for the origin-destination pair has the Import to Inbox field selected.

Vault Safety can receive single or multi-case E2B transmissions from the following sources:

  • E2B files sent through the Vault API Receive E2B endpoint
  • Incoming AS2 Gateway transmissions

Prerequisites

Before you can receive E2B transmissions from a trading partner or health authority, an administrator must set your vault up to communicate with the sender:

E2B Receive Process

The following image shows how Vault Safety processes incoming E2B transmissions:

Receive Gateway Transmissions Process
Receive Gateway Transmissions Process

When Vault Safety receives an E2B Individual Case Safety Report (ICSR) from an AS2 gateway or API transmission, the system performs the following actions:

  1. Creates an Inbound Transmission record.
  2. Adds the transmission documents to the Library, including:
    • The E2B file
    • Narrative and translations
    • Attachments
  3. Initiates the import E2B process to create an Inbox Item or AER from the E2B file.

    Tip By default, E2B transmissions are imported as AERs unless the Transmission Profile for the origin-destination pair has the Import to Inbox field selected.

  4. Notifies users in the Case Intake user group of the E2B import results.
  5. Generates an ICSR acknowledgment, which is attached to the Inbound Transmission.
  6. For Gateway transmissions, automatically returns the acknowledgment to the sender.

For E2B Import mapping, see E2B Case Import Data Mapping.

Acknowledgment Generation

When an AER or Inbox Item is imported from an E2B file, Vault Safety generates an ICH-compliant E2B ICSR acknowledgment in the same E2B format the file was received in. Vault Safety supports generating both E2B R2 and R3 ACKs.

For Gateway transmissions, the system automatically returns the acknowledgment to the origin Gateway.

For API transmissions, a separate API call (Retrieve Job Status) returns the acknowledgment.

You can also view the acknowledgment on the Inbound Transmission record, attached to the Case imported from the E2B file.

View the Acknowledgment

  1. From the Inbox, open the AER or Inbox Item received from an E2B transmission.
  2. Expand Inbound Transmissions.
  3. Open the Inbound Transmission, and then expand Transmission Messages.
  4. Open the Transmission Message.
    The acknowledgment file is an attachment on the Transmission Message.
  5. To view the acknowledgment, select Message Body.

Result

A window appears displaying the acknowledgment.

ACK Generation Mapping

Toggle between the following tabs to learn how Vault Safety generates E2B R2 and R3 ACKs.

The E2B (R3) Acknowledgment message is comprised of two sections:
  1. Message Header Section, which contains:
    • ACK.M Section ICSR Batch Acknowledgment Header
    • ACK.B section ICSR Message Acknowledgment Header (repeated for each report in the file)
  2. ACK.A Section ICSR Batch Acknowledgment Header
The following sections describe how Vault Safety maps information to populate the E2B (R3) ACK.

ACK.M/A ICH ICSR Batch Acknowledgment Header

E2B Data Element Name Populated Value
ACK.M.1 Acknowledgement Batch Number The GUID of the record being created.
ACK.M.2 Acknowledgement Batch Sender Identifier The value from the Destination ID (destination_transmission_id__v) field on the Inbound Transmission (transmission__v).
ACK.M.3 Acknowledgement Batch Receiver Identifier The value from the Origin ID (origin_transmission_id__v) field on the Inbound Transmission (transmission__v).
ACK.M.4 Acknowledgement Date of Batch Transmission The date and time to the second of the ACK generation.
ACK.A.1 ICSR Batch Number The value from the E2B Message ID (e2b_message_id__v) field on the Inbound Transmission (transmission__v), which is mapped from data element N.1.2 in the received E2B file.
ACK.A.2 Acknowledgement Local Message Number The message number is populated in the format {transmission__v.name__v}_{GUID}_YYYYMMDDHHMMSS
ACK.A.3 Date of ICSR Batch Transmission The value from the Transmission Date (transmission_date__v) field on the Inbound Transmission (transmission__v), which is mapped from data element N.1.5 in the received E2B file.
ACK.A.4 Transmission Acknowledgement Code An acknowledgment code is populated, based on the result of the E2B Import action.
  • AA—E2B Import Success
  • AE—E2B Import with Warnings
  • AR—E2B Failure
ACK.A.5 Batch Validation Error If ACK.A.4 is Warning (02) or Failure (03), this element contains the error message.

ACK.B.r ICH ICSR Message Acknowledgement Header

E2B Data Element Name Populated Value
ACK.B.r.1 ICSR Message Number If the inbound E2B file has a Wordlwide UID (C.1.8.1) that matches the AER UID, this value is mapped from the AER Worldwide UID (wwuid__v) field. Otherwise, this is mapped from the Case Identifier (name__v) of the Case Identifier (case_identifier__v) where (source__v == case_contact__v.organization__v of type Sender)
ACK.B.r.2 Local Report Number The Name (name__v) of the AER imported from the E2B file.
ACK.B.r.6 Acknowledgment Code for a ICSR Message An acknowledgement code is populated, based on the result of the E2B Import action.
  • CA—E2B Import Success or Success with Warnings
  • CR—E2B Failure
ACK.B.r.7 Error / Warning Message or Comment More details about the E2B import warning or failure from ACK.B.r.6, to a limit of 250 characters.
The E2B (R2) Acknowledgment message is comprised of two sections:
  1. Message Header Section
  2. Acknowledgment Section, which contains:
    • Message Acknowledgment
    • Report Acknowledgment (repeated for each report in the file)
The following sections describe how Vault Safety maps information to populate the E2B (R2) ACK.

M.1 ICSR Message Header

E2B Data Element Name Populated Value
M.1.1 Message Type Populated with ichicsrack
M.1.2 Message Format Version Populated with 1.1
M.1.3 Message Format Release Populated with 1.0
M.1.4 Message Number The GUID of the ACK message.
M.1.5 Message Sender Identifier The value from the Destination ID (destination_transmission_id__v) field on the Inbound Transmission (transmission__v).
M.1.6 Message Receiver Identifier The value from the Origin ID (origin_transmission_id__v) field on the Inbound Transmission (transmission__v).
M.1.7 Message Date The date and time to the second of the ACK generation.

A.1 Message Acknowledgement

E2B Data Element Name Populated Value
A.1.1 ICSR Message Number The value from the E2B Message ID (e2b_message_id__v) field on the Inbound Transmission (transmission__v), which is mapped from data element N.1.2 in the received E2B file.
A.1.5b ICSR Message Date The value from the Transmission Date (transmission_date__v) field on the Inbound Transmission (transmission__v), which is mapped from data element N.1.5 in the received E2B file.
A.1.6 Transmission Acknowledgement Code An acknowledgment code is populated, based on the result of the E2B Import action.
  • 01—All reports loaded into the database
  • 02—ICSR Error, not all reports loaded into the database, check section B for errors
  • 03—SGML parsing error, no data extracted
A.1.7 Parsing Error Message If A.1.6 is 03, then this element is populated with "Message cannot be parsed."

B.1 Report Acknowledgement

E2B Data Element Name Populated Value
B.1.1 Safety Report ID If the inbound E2B file has a Wordlwide UID (C.1.8.1) that matches the AER UID, this value is mapped from the AER Worldwide UID (wwuid__v) field. Otherwise, this is mapped from the Case Identifier (name__v) of the Case Identifier (case_identifier__v) where (source__v == case_contact__v.organization__v of type Sender)
B.1.3 Local Report Number The Name (name__v) of the AER imported from the E2B file.
B.1.4 Regulatory Authority's Case Report Number The value from the Worldwide UID (wwuid__v) field on the AER, which is mapped from data element A.1.10.1 in the received E2B file. This element is displayed if the Inbound Transmission.First Sender = Regulatory (the file was sent from a regulatory authority).
B.1.5 Other Sender's Case Report Number This is mapped from the data element A.1.10.2 in the received E2B file. This element is displayed if the Inbound Transmission.First Sender = Other (the file was sent from a non-regulatory sender).
B.1.7 Date of Receipt of the Most Recent Information This is mapped from the data element A.1.7 in the received E2B file.
B.1.8 Acknowledgment Code for a Report An acknowledgement code is populated, based on the result of the individual ICSR import.
  • 01—Report Loaded Successfully
  • 02—Report Not Loaded
B.1.9 Error Message or Comment More details about the specific E2B import warnings or failures encountered, to a limit of 250 characters.

Case Intake Overview
E2B Case Import Data Mapping
Feedback?