Rule Types and Settings - IHE - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

IHE Solutions

Platform
OnBase
Product
IHE
Release
Foundation 23.1
License
Standard
Essential
Premier

Each type of rule controls the parsing and generation of message attributes in a specific way and in a specific context. Some rule types have extra settings or child rules, while others simply map one piece of data to a message attribute.

The following table describes each rule type and its settings, as well as the processing and encoding types of the message attributes which the rule type can be applied to.

Rule Type

Description and Settings

Applicable Processing and Encoding Types

<Complex>

Maps an attribute to a multifaceted piece of data using child rules. Each child rule maps part of the data to specific component parts of the attribute.

Settings:

  • Coded Value Set: Use the drop-down list to apply a coded value set. The child rules use various parts of the set for their assigned component attributes.

Note:

This setting is not available for all message attributes.

This rule type applies child rules to component attributes. See Component Attributes and Child Rules for more information.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • Classification

  • External Identifier

<System>

Stores message data from an attribute.

This rule type can only be system generated.

There are no additional settings for this rule type.

Note:

Because it is only applicable for System processing, you cannot create new <System> rules or modify existing ones.

Processing Types:

  • System

Association Type

Populates an attribute with a value used to specify a HasMember or Document Relationship association type.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Availability Status

Populates an attribute with the lifecycle status of the object.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Code

Maps a component attribute to the coded value applied to the document.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • XML Attribute

Coding Scheme

Maps a component attribute to the coding scheme to which the document's coded value belongs.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • Slot

Date Stored

Populates an attribute with the date the document was created by its author.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • Slot

Display Name

Maps a component attribute to the name the document's coded value is translated as.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • Name

Document Date

Maps an attribute to the OnBase Document Date property.

There are no additional settings for this rule type.

Processing Types:

  • Source

  • Repository:

Encoding Types:

  • Slot

Document Type

Maps an attribute to a coded value set and maps specific coded values to community Document Types.

Each incoming document is assigned to the Document Type mapped to its coded value, and the outgoing metadata of a document includes a coded value corresponding to its Document Type.

Settings:

  • Coded Value Set: Use the drop-down list to select a coded value set. Document Types are mapped to coded values in this set, and the child component rules use different aspects of the set for their assigned message attributes.

    Note:

    Coded value sets must be populated before they can be mapped to an attribute. See Coded Value Set Configuration.

  • Document Type Mappings: The list displays community Document Types that have been mapped to coded values. Each Document Type can only be mapped once.

To map a community Document Type to a coded value:

  1. After a coded value set has been selected, click Add. The Document Type Mapping dialog box is displayed.

  2. Select a Document Type to be mapped from the drop-down list.

  3. Select a Coded Value from the list.

  4. Click Add.

You can use the Edit and Delete buttons to change existing Document Type mappings.

This rule type applies child rules to component attributes. See Component Attributes and Child Rules for more information.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • Classification

Note:

This rule can only be applied when the required child attributes are present.

Hash

Populates an attribute with the hash value of the document's byte data.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • Slot

Home Community ID

Populates an attribute with the identifier for the community which the sending system belongs to. This ID is set in the Home Community ID field of the Community Settings dialog box.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

  • Slot

Keyword Type

Maps an attribute to the selected Keyword Type.

The value of the message attribute is saved as a Keyword Value of this type for incoming documents, and outgoing documents use their existing Keyword Values to populate this attribute.

Settings:

  • Keyword Type: Use the drop-down list to select a Keyword Type to map to the attribute.

  • Process as Patient ID: If the Keyword Type selected above is used to store patient IDs, select this option to map it to the attribute according to the standard IHE format for a patient ID. This format appends the Patient ID Domain set in the Community Settings dialog box, ensuring uniqueness by specifying an assigning authority for the ID.

Note:

Ensure that the Keyword Type you select is assigned to all community Document Types.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • XML Attribute

  • Slot

  • Name

  • Description

  • Element

Mapped Keyword Value

Maps Keyword Values to specific coded values, so that a single Keyword Value on an outgoing document can be used to populate component attributes with a code, scheme, and display name.

Settings:

  • Coded Value Set: Use the drop-down list to select the set from which coded values can be mapped.

  • Keyword Type: Use the drop-down list to select a Keyword Type whose values you want to map to coded values.

To map Keyword Values to coded values:

  1. Select a Coded Value Set and Keyword Type from the drop-down lists.

  2. Click Add. The Keyword Value Mapping dialog box is displayed, listing coded values from the selected set.

  3. Enter the value you want to map in the Keyword Value field.

  4. Select a coded value to map from the Coded Value list.

  5. Click Save.

  6. Map additional Keyword Values to coded values as needed.

Processing Types:

  • Source

Encoding Types:

  • Classification

MIME Type

Maps an attribute to the document's media type, which identifies the file format and extension to use for reading and saving the document.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • XML Attribute

Object Type

Populates an attribute with a value that identifies the type of metadata the object contains.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

OID

Populates an attribute with the identifier for the object it belongs to.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Parent UUID

Populates an attribute with the universal unique identifier for a parent object.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Repository Unique ID

Populates an attribute with the OnBase Repository Unique ID, identifying the system from which the document can be accessed. This ID is displayed in the OnBase Repository Unique ID field of the Community Settings dialog box.

This rule type can only be system generated.

Processing Types:

  • Source

Encoding Types:

  • Slot

Size

Populates an attribute with the size (in bytes) of the byte stream that composes the document.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • Slot

Source ID

Populates an attribute with the OnBase Source ID, identifying the system that created the document. This ID is displayed in the OnBase Source ID field of the Community Settings dialog box.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • External Identifier

Source UUID

Populates an attribute with the universal unique identifier of the system sending the message.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Static Value

Populates an attribute with a preconfigured value.

Note:

The settings for this rule type change depending on whether the attribute it is applied to has an Classification encoding type.

Settings:

  • Default Value: Select to use the system default value for the selected attribute. The default value could be a UUID, a status indicator, or some other type of value the attribute is usually expected to hold. If there is no default value for the attribute, this option is disabled.

  • Custom Value: Enter a text string to use for the value.

Settings(Classification):

  • Display Name: Enter a name that is translated from the coded value.

  • Code: Enter the coded value to apply to documents.

  • Coding Scheme: Enter the coding scheme which the coded value belongs to.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

  • Classification

  • Slot

  • Name

  • Description

  • Element

Note:

This rule can only be applied when the required child attributes are present.

Submission Set UUID

Populates an attribute with the universal unique identifier of a submission set.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Submission Time

Populates an attribute with the time the message was generated.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • Slot

Target UUID

Populates an attribute with the universal unique identifier of the system intended to receive the message.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute

Template

Maps an IHE field template to an attribute, allowing HL7 message data found in the attribute to be processed as configured in the template.

Settings:

Note:

System templates are not available to be mapped to attributes.

Processing Types:

  • Source

  • Repository

Encoding Types:

  • XML Attribute

  • Slot

  • Name

  • Description

  • Element

Note:

Templates with more than one field group can are only applicable for attributes with a Slot encoding type.

UUID

Populates an attribute with a universal unique identifier for a metadata or association object.

This rule type can only be system generated.

There are no additional settings for this rule type.

Processing Types:

  • Source

Encoding Types:

  • XML Attribute