Implementing Patient Access Photo Upload

The Imprivata Patient Access – Photo Upload application is a backend FHIR application that sends patient photos to the customer’s HL7v2 interface using OAuth 2.0 Backend Authentication. The customer’s Interface team must set up the required HL7v2 interfaces and can contact their Epic1 EDI support for assistance. For general guidance on implementing interfaces, see the Getting Started with HL7 Interfaces tutorial.

Information to Send to the Customer

  1. Client IDs - The customer will use either the Non-Production or Production client ID in their Backend OAuth 2.0 configuration, depending on the environment. The customer's IT team will map the client ID to an Epic user account for the purposes of auditing and providing security to invoke web service calls made by the backend application.

    Only the client IDs for the Imprivata Patient Access – Photo Upload app are required.

    Application Name Non-production Client ID Production Client ID
    Imprivata Patient Access – Photo Upload e2673269-0ebe-4ed9-99cd-3ddf5b72ba12 8b3dfe11-91be-421b-80ae-cb53f8d7cf09

  2. Interface the app requires - HL7v2

  3. The communication method - HL7v2 interfaces support HTTPS

  4. Description of interface filter criteria - Imprivata sends an A31 event that contains the patient photo and MRN to HL7v2 interface via HTTPS.

    Example

    Copy 
    MSH|^~\&|IMPRIVATA||test|test|20240723171010||ADT^A31||T|2.3 
    EVN|A31|20240723171010| 
    PID|1||3983^^^AssigningAuthority^MR||||| 
    OBX|1|ED|IJL||^^JPG^BASE64^{ImageBase64String} 

Information to Obtain from the Customer

The customer coordinates with their Epic team to obtain the following information:

  1. HL7v2 Interface endpoint (HTTPs)

    Example: https://vendorservices.epic.com/interconnect-amcurprd-oauth/api/epic/2015/EDI/HTTP/HL7v2/12870103

  2. Technical Connection information - The Interconnect instance base URL for FHIR API traffic.

    Example: https://vendorservices.epic.com/interconnect-amcurprd-oauth

  3. HL7 Message Field Mapping Requirements

    Receiving Facility: the expected values in MSH.5

    Receiving Application: the expected values in MSH.6

    MRN Assigning Authority: the expected values in PID.3.4

    MRN Type Code: the expected values in PID.3.5

  4. Data Mapping Requirements - The FHIR OID for patient medical record number (MRN)

    Example: urn:oid:1.2.840.114350.1.13.0.1.7.5.737384.14

Configure the HL7 Integration in Patient Access

With the information above, the Imprivata implementation engineer uses the customer’s Patient Access Admin Console to configure the HL7 integration.

Create the HL7 System

  1. In the Admin Console, navigate to Integrations > HL7. Click Add HL7 system.

  2. In the Client ID box, type the client identifier for the service. If this is a test tenant, this is the non-production ID for the Imprivata Patient Access – Photo Upload app. If this is the production tenant, this is the production client ID.

  3. In the HL7v2 interface endpoint box, type the address of the endpoint. The value is {HL7v2 interface HTTPS endpoint}.

  4. In the Token Endpoint box, type the address of the endpoint. The value is {InterconnectInstanceBaseURL}/oauth2/token}.

  5. In the Receiving facility (MSH.5) box, specify the receiving facility. The value is the expected value in MSH.5.

  6. In the Receiving application (MSH.6) box, specify the receiving application. The value is the expected value in MSH.6.

Add an HL7 Rule

Rules define the Patient Access events, such as Photo Added, that can trigger Patient Access to send messages.

HL7 Outbound rules must have patient identifiers configured to send within the HL7 message.

To add an HL7 rule:

  1. Click + Add HL7 Rule.

  2. Specify the following information:

    1. Friendly Name. Enter a friendly name that describes the rule.

    2. FHIR OID. Enter the FHIR OID for patient medical record number (MRN).

    3. HL7 identifier assigning authority (PID3.4). The expected value in PID.3.4.

    4. HL7 identifier coding system (PID3.5). The expected value in PID.3.5.