The IDMP viewer consolidates and displays medicinal product submission data in a unified view, allowing your organization to more easily review IDMP data prior to and following submission.
Note: This feature is only available on RIM Registrations Vaults and must be configured by an Admin.
How the IDMP Viewer Works
The IDMP Viewer home page is a view of IDMP element record data you’ve selected to review in comparison to an IDMP submission, such as Medicinal Product Element and Packaged Medicinal Product. The data and records displayed in the viewer are the IDMP Product Data Submission records in scope of a Regulatory Objective.
You can initiate an IDMP Viewer session using the Generate IDMP Data View action from an individual IDMP Product Data Submission record, or you can execute the action from an IDMP Grouping record containing up to 20 IDMP Product Data Submission records. When you execute the action, Vault generates a notification containing your unique link to an IDMP Viewer session. During this process, Vault also generates a temporary pivot file to collect data in the background, allowing you to edit and save changes during the session and return to your open viewer session at any time.
The data displayed in the viewer represents a list of fields and values on an IDMP output record, for example IDMP Medicinal Product Element. You can filter and sort by field names and values, in addition to applying a view to show any fields Vault identifies as having multiple values. Any mismatching data points among like records can be updated where necessary directly in the viewer.
When you’re finished working with the viewer, you can commit the data to the Vault, which applies any output record updates and ends your IDMP viewer session by inactivating the session link. Once the session link is inactive, you must initiate a new session from an IDMP Grouping or IDMP Product Data Submission record.
You can also view FHIR messages in human-readable format within the IDMP Viewer. For more information, see Viewing FHIR Messages.
Working with IDMP Groupings
You can create an IDMP Grouping object record to collect for review up to 20 IDMP Product Data Submission records which are in scope of the related Regulatory Objective. To review data for a single IDMP Product Data Submission record, see Initiating an IDMP Viewer Session.
To create an IDMP grouping:
- Locate the Regulatory Objective record and navigate to the IDMP Groupings section.
- Click Create, populate any required fields, and click Save. Vault loads the Regulatory Objective record page.
- Navigate to the IDMP Groupings section and open the record you created.
- Within the IDMP Product Data Submissions section, click Create.
- In the Create IDMP Product Data Submission dialog, populate a Medicinal Product and any other required fields. Click Save.
- Repeat these steps as applicable for any remaining IDMP Product Data Submission records. Ensure the IDMP Grouping has no more than 20 such records associated. Selecting more than 20 records will cause the Vault system job which generates the data view to error.
Initiating an IDMP Viewer Session
You can initiate an IDMP Viewer session from an IDMP Grouping record, or from a single IDMP Product Data Submission record. Depending on your Vault’s configuration, access to the viewer may be limited to IDMP Grouping or IDMP Product Data Submission records in specific object lifecycle states.
- Navigate to a Regulatory Objective object record and locate the IDMP Grouping or IDMP Product Data Submission record you wish to load in the viewer.
- In the record’s Actions menu, select Generate IDMP Data View. Depending on your Vault’s configuration, you may be required to select an IDMP Data View Owner and click Continue. If you are not prompted to select an owner, Vault designates you as the IDMP Data View Owner when it processes the action. In both scenarios, this value is set on any IDMP Product Data Submission record(s) in scope of the viewer session.
- Vault begins processing the request. Once complete, you (or the selected owner) will receive a notification with a link to the IDMP Viewer session. The notification also includes a CSV file confirming the action results.
- Click the IDMP Viewer link to access your session.
In addition to generating the notification and link, Vault:
- Locks all in-scope IDMP Product Data Submission and selected IDMP output records, allowing only the IDMP Data View Owner to edit and view, either within the viewer or the object record page in the Vault.
- Generates a pivot file containing a snapshot of the current data selected when generating the view. This pivot file allows you to refresh and edit data in the viewer.
Vault performs these actions asynchronously within the Generate IDMP Data View system job.
Working in the IDMP viewer
Reinitiating a Session
While your IDMP viewer session is active, you can use the link provided in the original notification to return to the session as needed. The access link will not work for any user other than the user who received the notification, even if the link was generated by another user.
Committing & Closing a Session
When your review is complete, use the Commit button to confirm and close the IDMP viewer session, even if you did not make any changes.
Upon committing, Vault permanently ends the IDMP viewer session and:
- Updates the IDMP output records with any changes captured within the pivot file during the session.
- Unlocks the IDMP Product Data Submission and selected IDMP output records, allowing other users to edit and view them within a new viewer session.
- Inactivates the session link from the original IDMP viewer session notification. If you attempt to reinitiate the session from an inactive link, Vault displays a “Page Not Found” error message, and you must return to the IDMP Grouping or IDMP Product Data Submission record to initiate a new session.
- Purges the pivot file.
Vault performs these actions asynchronously within the Commit IDMP Data View system job.