Setting Up the RIM Reference Model (RIM)

RIM Reference Model and RIM Reference Model Mapping are standard objects that reference and map to document types in your Vault, allowing your organization to create a standard document type hierarchy. This article will help you understand how to configure and work with the RIM Reference Model and RIM Reference Model Mapping objects to support standard Vault connections, the Active Dossier, and other future functionality.

Reference Model Objects

The RIM Reference Model object records make up the structure of the standard document type hierarchy. Unlike other objects, the object data records for RIM Reference Model are completely provisioned and maintained by Veeva. You can only update the Primary Document Type field on RIM Reference Model records.

The RIM Reference Model Mapping object records map each individual RIM document type in your Vault to a document type or reference model in other connected Vaults, for example a Clinical Operations Vault. Some object data records for RIM Reference Model Mapping are provisioned and maintained by Veeva. On Veeva-provisioned records, you can only edit the Status and RIM Document Type to set up mappings. These records have a unique Vault RIM UUID field value populated. You can also create additional RIM Reference Model Mapping records for document types or content types outside of the standard reference model, although you cannot set the Vault RIM UUID field on these records.

Veeva will continue to add RIM Reference Model and RIM Reference Model Mapping records to all RIM Vaults. You cannot delete any RIM Reference Model or RIM Reference Model Mapping records provisioned by Veeva.

Reference Model Fields

Several fields on the RIM Reference Model and RIM Reference Model Mapping objects support document type mapping:

RIM Reference Model Fields

  • Primary Document Type: The main Document Type represented by the RIM Reference Model.
  • Version Introduced: The Vault release in which the RIM Reference Model record was introduced, for example, 21.2.

RIM Reference Model Mapping Fields

  • RIM Reference Model: The parent RIM Reference Model record.
  • Mapping Type: Whether this record maps a specific document type from the inbound Vault or a content type, for example, the TMF Reference Model in a connected Clinical Operations Vault.
  • Mapping Location: The Vault application family or RIM-specific feature the mapping supports; for example, if the mapping supports the Clinical Operations and RIM Vault Connection, the Mapping Location is Clinical Operations.
  • RIM Document Type: The Document Type to map to in the RIM Vault.
  • Mapping ID: The External ID of a Document Type or mapping record in the connected Vault, for example, the External ID of an Artifact (hierarchy__v) record in a connected Clinical Operations Vault.
  • Unique Mapping ID: A Vault-populated combination of the Mapping ID and Mapping Location. This field is system-managed.
  • Version Introduced: The Vault release in which the RIM Reference Model Mapping record was introduced, for example, 21.2.

Setting Up the Standard RIM Reference Model

To associate a document type to RIM Reference Model and RIM Reference Model Mapping records:

  1. Navigate to Admin > Business Admin > RIM Reference Model and open a record for specific document type.
  2. In the Primary Document Type, select the main document type to assign to this portion of the reference model.
  3. Click Save.
  4. In the RIM Reference Model Mappings related object section, open a related RIM Reference Model Mapping record.
  5. Click Edit.
  6. In the RIM Document Type field, select the document type for the mapping.
  7. Change the Status to Active.
  8. Click Save.
  9. Repeat these steps until all document types in your RIM Vault are mapped.

To allow your Vault to use the RIM Reference Model when managing the Active Dossier, update the Document Type field on the RIM Reference Model records. If your Vault uses a standard Vault connection, like the Clinical Operations and RIM Vault Connection, ensure all document types in the connected Vault are mapped in the RIM Document Type field on the RIM Reference Model Mapping records. See details about the RIM Reference Model and Vault Connections below.

Using Vault Loader with the RIM Reference Model

You can use the following Vault Loader files as a starting point to set the RIM Document Type on the RIM Reference Model and RIM Reference Model Mapping records:

The document types included in these files are based on the latest document types delivered in new RIM Vaults. You must assess these against your organization’s currently configured document types to ensure that your organization can address any discrepancies in document types before loading these files.

Setting Up Custom Reference Model Mappings

You can set up custom RIM Reference Model Mapping records in addition to the records provided by Veeva to extend your reference model. For example, you can create additional RIM Reference Model Mapping records to map additional forms using a standard Vault connection under a single RIM Reference Model Form record.

To create custom RIM Reference Model Mapping records:

  1. Navigate to Admin > Business Admin > RIM Reference Model Mapping and click Create.
  2. Enter a Name.
  3. In the RIM Reference Model field, select the associated parent RIM Reference Model record.
  4. Select the Mapping Type, Mapping Location, and RIM Document Type.
  5. Enter the Mapping ID. Vault automatically populates the Unique Mapping ID by combining the Mapping ID and Mapping Location.
  6. Ensure the Status is set to Active.
  7. Click Save.

Note that your Vault can only have one (1) RIM Reference Model Mapping record for each unique combination of Mapping Location and RIM Document Type. This prevents Vault from mapping an external document or content type from a connected Vault to multiple document types in your RIM Vault.

How Active Dossier Uses the RIM Reference Model

Active Dossier functionality in Vault uses a Document Type field to determine the documents to include in the Active Dossier structure. If document types aren’t defined on the Active Dossier Template records, Vault can use the RIM Reference Model instead. See Active Dossier Configuration for more information.

How Vault Connections Use the RIM Reference Model

Standardized Vault connections, for example, the Clinical Operations and RIM Vault Connection, use Document Type reference lookups to map source document types to target document types when creating CrossLink documents. If the connection doesn’t include Document Type reference lookups, Vault can use the RIM Reference Model instead. The connection configuration defines which documents are transferred, but the RIM Reference Model can help determine the document type assigned to the CrossLink document created in your RIM Vault.

When a relevant Document Type reference lookup doesn’t exist, Vault retrieves the External ID of the document type or content type in the connected Vault and compares it to active RIM Reference Model Mapping records using the following fields:

  • Mapping Type
  • Mapping ID
  • Mapping Location
  • RIM Document Type

When a match exists, Vault creates the CrossLink document and classifies it under the document type in the RIM Document Type field on the RIM Reference Model Mapping record. If matching RIM Reference Model Mapping records exist for both Document Type and Content Type mapping, Vault classifies the document under the RIM Document Type on the record with Content Type mapping. If multiple valid records exist with Content Type mapping, Vault references the RIM Reference Model Mapping record that was created most recently. If a matching RIM Reference Model Mapping record and Document Type reference lookup doesn’t exist, or if there are multiple valid RIM Reference Model Mapping records created at the same time, Vault creates a User Exception Item record to capture the failure.