Installing Upgrading Designing Configuring Deploying Monitoring Administering Troubleshooting Reference JBI Components
Close Print View
Designing: Artifact Codes
 

Classic Java CAPS

Developing Java CAPS Projects

Using SOAP Message Handlers

Creating a Runtime Environment

Designing Business Processes in the Sun Business Process Manager

Working with TCP/IP HL7 Collaborations

TCP/IP HL7 Adapter Collaborations Overview

TCP/IP HL7 Adapter Task Overview

TCP/IP HL7 V2 Adapter Collaborations

Inbound HL7 V2 Collaboration Overview

Outbound HL7 V2 Collaboration Overview

Limitations of Version 2.x

Creating a Copy of an HL7 V2 Project

To Export a Project

Customizing Predefined Collaborations for HL7 V2

Creating Copies of an HL7 V2 Collaborations

To Create Copies of an HL7 V2 Collaborations

Adding HL7 V2 OTD to an Existing Collaboration

To Add HL7 V2 OTD to an Existing Collaboration

TCP/IP HL7 V3 Adapter Collaborations

Introducing the Methodology

What's New with HL7 V3

Artifact Identification System

HL7 V3 Message Development Process

Artifact Codes

Transmission Wrapper and Control Act Wrapper

Comparison between HL7 V2.x and HL7 V3

Benefits of V3 to HL7

Inbound HL7 V3 Collaboration

Inbound HL7 V3 Immediate Collaboration Overview

Inbound HL7 V3 Deferred Collaboration Overview

Outbound HL7 V3 Collaboration

Outbound HL7 V3 Collaboration Overview

Creating a Copy of an HL7 V3 Project

Customizing Predefined Collaborations for HL7 V3

Creating Copies of an HL7 V3 Collaborations

Adding HL7 V3 OTD to an Existing Collaboration

To Add HL7 V3 OTD to an Existing Collaboration

MLLP V2

MLLP V2 Content Exchange Model

Standard Inbound HL7 V2 Collaboration Overview over MLLPV2

Developing Sun Master Indexes (Repository)

Developing Sun Master Patient Indexes

Developing OTDs for Application Adapters

Developing OTDs for Communication Adapters

Developing OTDs for Database Adapters

Developing OTDs for Web Server Adapters

Designing with Application Adapters

Designing with Communication Adapters

Designing with Web Server Adapters

SWIFT Integration Projects

Java EE Based Components

Designing with Sun JCA Adapters

About the TCP/IP JCA Adapter

Defining Constants and Variables

Using Database Operations

Developing Sun Master Indexes

Using the JMS JCA Wizard

Using the JAXB Wizard and Code-Seeder Pallete

Artifact Codes

As pet the process of V3 message development, where V3 information models are refined to come up with XML schemas which can be used to construct V3 XML messages. The specification development process identifies various artifacts for a particular domain and submits them. For every domain, the artifacts are organized in the same structure. The following Artifact Codes have been assigned.

Artifact Codes

Artifact
Code
Application Role
AR
Domain Information Model (D-MIM)
DM
Hierarchical Message Descriptor (HMD)
HD
Interaction
IN
Message Type
MT
Refined Message Information Model (R-MIM)
RM
Storyboard
ST
Storyboard Narrative
SN
Trigger Event
TE

The Patient Administration domain submits an application role with the following unique artifact identifier:

PRPA_AR00001UV00

Where:

PR Subsection: PracticePA Domain: Patient AdministrationAR Artifact: Application Role00001 6 digit non-meaningful number assigned by the TC to ensure uniquenessUV Realm (the only current value is UV for universal) 00 Current version number

Application Role (Code: AR)

Application roles represent a set of communication responsibilities an application can implement. Thus, they describe system components or sub-components that send and/or receive interactions.

Patient Billing Account Informer

Structured Name
Artifact Identifier
Description
Patient Billing Account Event Informer
FIAB_AR010001UV01
Informs a tracker of patient billing account creates (activate), update (revise), closes (complete), deletes (nullify), and merges (obsolete)
Trigger Event (Code: TE)

A trigger event is a condition on which an action is initiated. HL7 adapter covers interaction based trigger events.

Close Patient Billing Account

Structured Name
Artifact Identifier
Description
Patient Billing Account Event Complete Notification

Type: State-transition based

FIAB_TE010003UV01
This trigger event signals that the status of a patient billing account is rendered closed. This means it is no longer eligible for financial transaction posting.
Storyboard (Code: ST)

A storyboard explains the series of actions in a particular scenario. Its primary purpose is to identify the various scenarios. Each storyboard is represented as sequence diagrams. It also lists the interactions between two or more systems playing different Application Roles.

HL7 Storyboard
Storyboard Narration (Code: SN)

A Storyboard narrative provides explanation for the storyboard.

Close Patient Account

Structured Name
Artifact Identifier
Description
Patient Account Close
FIAB_SN000106UV01
Ms Smith's account for a previous visit is at a zero balance and has not had any activity for some specified period of time. The account is closed, declared inactive and not available for further activity, preparatory to archiving and/or removal from the administrative system.
Domain Information Model (D-MIM) (Code: DM)

Domain specific classes represented in a diagram with relationships.

Refined Message Information Model (R-MIM) (Code: RM)

A subset of D-MIM classes represented in a diagram with relationships. These classes specifically represent information content for one or more HMDs.

Hierarchical Message Descriptor (HMD) (Code: HD)

The Message Structures or Message types which form the payload of the data transmitted. The base HMD is depicted in a tabular format or in excel view. It also lists the various message types built based on this HMD.

Figure 16 Hierarchical Message Descriptor
Hierarchical Message
Message Type (Code: MT)

A message type represents a unique set of constraints applied against the common message. It is represented in Table view or in XML schema view.

Interaction (Code: IN)

Interactions are at the heart of messaging. Interactions define the interaction between two systems. The documentation of interaction defines the following interactions.

  1. Trigger Event which initiated the interaction.

  2. Message Type which should be used for interaction (the payload).

  3. Transmission Wrapper: A Message Type to wrap the payload.

  4. Control Act Wrapper: A Message Type to hold the administration information about the payload being transmitted.

  5. Sender: The Sender Role for this interaction.

  6. Receiver: The Receiver Role for this interaction.

Close Patient Billing Account Notification

Structured Name
Artifact Identifier
Description
Patient Billing Account Event Complete Notification
FIAB_IN010003UV01
Close patient billing account
Figure 17 Close Patient Billing Account
Close Patient Billing Account
Figure 18 Sending and Receiving Roles
Sending and Receiving Roles