HL7 v3 and caAdapter Overview 20071112

HL7 v3 and caAdapter Overview

Session Date:

Session Length: 1 hour

Trainer:

Session Details

Target Audience: caBIG™ community interested in HL7 v3, caAdapter users, HL7 v3 message builders, NCI Managers, Application Developers, and Domain Analysts.

Prerequisites: None

Session Details:

Presenters and Participants

Who is Presenting:

Who is in attendance?– Name– Title– Cancer Center or Organization– Reason for Attending

Session Details:

Online Training Environment: Centra…

Use these buttons (or choose from the Actions menu) to communicate with the trainer and other attendees.

Example:Raise your hand to ask a question.

Session Details:

Online Training Environment: Centra

You can adjust what you see on screen by choosing from the View menu or by scrolling with the slide bars.

Session Details:

Online Training Etiquette

Be an active learner! – Ask lots of questions. – Avoid the temptation to multi-task; keep distractions to a minimum.

When not actively asking a question or making a comment, please keep your phone on MUTE.– This will minimize background noise so that all can hear the

person who is speaking.

Please do not put your phone on HOLD.– Telephone HOLD music will disrupt the call.

When asking a question or making a comment, please state your name. – This way, all participants will know who is speaking.

Session Details:

Session Objectives

Upon successful completion of this session, you will be able to:– Provide an introduction to HL7 v3– Discuss what HL7 v3 is and how it works– Explain why HL7 v3 and caAdapter are used within NCI CBIIT

and caBIG™– Describe what caAdapter is and how it works

Session Details:

Lesson Plan

Introduction to HL7

HL7 v3 Components and Process

HL7 v3 Interoperability and caBIG™

High Level Overview of the caAdapter Tool

Introduction to HL7

In this lesson, we will:– Explain what HL7 is and what it does– Discuss HL7 v2 and its issues– Describe what HL7 v3 is and what it does

HL7 is an ANSI-accredited Standards Development Organization (SDO) operating in the healthcare arena.

It is a non-profit organization made up of volunteers – providers, customers, vendors, government, etc.

HL7 is an acronym for Health Level Seven– Seven represents the highest, or “application,” level of the

International Standards Organization (ISO) communications model for Open Systems Interconnection (OSI) networks.

Introduction to HL7:

What is Health Level Seven (HL7)?

Provides standards for data exchange to allow interoperability between healthcare information systems

What is interoperability?– It is the ability of two or more systems or components to exchange

information, and to use the information that has been exchanged predictably (IEEE Standard Computer Dictionary)

HL7’s key goal of interoperability has two aspects:– Syntactic interoperability has to do with structure– Semantic interoperability has to do with meaning


What HL7 does…


What HL7 does

HL7 focuses on the clinical and administrative data domains.

It defines data exchange standards for these domains called messages or messaging specifications (aka HL7 messages).– Messages are developed by technical committees and special

interest groups in the HL7 organization.

HL7 organization defines 2 versions of the messaging standard:– HL7 v2.x (syntactic only)– HL7 v3.0 (semantic capability added)

HL7 messaging (v2.x and higher) has been recommended as a data exchange standard by the E-Government initiative.


The Industry Standard

HL7 v2 is still the most commonly used HL7 standard– Over 90% of US hospitals have implemented some version of 2.x

HL7 messages

The HL7 v2 messaging standard is considered:– The workhorse of data exchange in healthcare– The most widely implemented standard for healthcare information

in the world

HL7 v2.5 was approved as an ANSI standard in 2003

HL7 v2.6 is currently under development.

HL7 v2 development process has no explicit methodology.

HL7 v2 does not support semantic grouping of messages to create comprehensive packets of information.

HL7 v2 messages do not specify coded terminologies as value sets.

HL7 v2 does not have conformance rules – this results in site specific implementation.

HL7 v2 is an interchange standard, not an interoperability standard.

HL7 v2 works well intra-enterprise, but does not scale well to inter-enterprise applications.


Problems with HL7 v2…

Source: Charlie Mead, MD


Problems with HL7 v2

MSH|^~\&|GHH LAB|ELAB-3|GHH OE|BLDG4|200202150930||ORU^R01

|CNTRL-3456|P|2.4<cr> PID|||555-44-4444||EVERYWOMANÊVEÊ^^^^L|JONES |196203520|F|||153 FERNWOOD DR.^^STATESVILLEÔH^35292||(206)3345232|(206)752-121||||

AC555444444||67-A4335ÔH^20030520<cr> OBR|1|845439^GHH OE|1045813^GHH LAB|1554-5^GLUCOSE|||200202150730|||||| 555-55-5555^PRIMARY^PATRICIA P^^^^MD^^LEVEL SEVEN HEALTHCARE, INC.

|||||||||F||||||444-44-4444^HIPPOCRATES^HOWARD H^^^^MD<cr> OBX|1|SN|1554-5^GLUCOSE^POST 12H CFST:MCNC:PT:SER/PLAS:QN||^182|mg/dl| 70_105|H|||F<cr>

Example HL7 v2.4 ORU^R01 for serum glucose:


The HL7 v3 Solution…

HL7 v3 is not the next release of HL7 v2 - It is a paradigm shift

HL7 v3 addresses the problems of HL7 v2 by:– Reducing HL7 v2 optionality– Including testable conformance rules

HL7 v3 is based on a formal development methodology:– Follows an Object Oriented (OO) approach– Uses Universal Modeling Language (UML) principles

Most importantly, HL7 v3 supports semantic interoperability


The HL7 v3 Solution

Additional HL7 v3 features include:– A uniform set of models – Representation of complex relationships – Formalisms for vocabulary support – Top-down message development – Solving re-use and interoperability issues across multiple domain

contexts – Scope is expanding to include community medicine, epidemiology,

veterinary medicine, clinical genomics, security, etc.


The Four Pillars of Semantic Interoperability in HL7 v3

A common Reference Information Model (RIM) which spans the entire patient care, administrative and financial healthcare universe

A well-defined and tool-supported process for deriving data exchange specifications ("messages") from the RIM

A formal and robust Data Type Specification upon which to ground the RIM

A formal methodology for binding concept-based terminologies to RIM attributes


Any Questions?

What HL7 is and what it does

HL7 v2 and its issues

What HL7 v3 is and what it does

HL7 v3 Components and Process

In this Lesson, we will:– Describe the components of HL7 v3 that support semantic

interoperability.

HL7 v3 Components and Process: Reference Information Model (RIM)

The RIM is the cornerstone of HL7 v3 messaging.

The RIM is an UML Model class diagram.

The RIM:– Is the fundamental model from which all v3 messages are

derived– Is a generic, abstract model that expresses the information

content of all the areas of healthcare– Forms a shared view of the healthcare domain, and is used

across all HL7 messages independent of message structure

HL7 v3 Components and Process:

RIM Domains

Administrative Management

Accounting & Billing

Claims & Reimbursement

Patient Administration

Scheduling

Health & Clinical Management

Clinical Document Arch.

Medical Records

Public Health Reporting

Regulated Studies

Common Domains

Common Message Element Types (CMETs)

Shared Messages


The Complete RIM Pictorial

Classes are color coded:– Green = Entity, Yellow = Role, Blue = Participation, Red/Pink = Act,

Purple = Infrastructure, Lilac = message controller.

Observation

...

SubstanceAdministration

routeCode : CE...

Procedure

...

Supply

...

Diet

...

Document

...

ContainercapacityQuantity : PQheightQuantity : PQdiameterQuantity : PQcapTypeCode : CE...

AccessapproachSiteCode : CD......

DevicemanufacturerModelName : SCsoftwareName : SClocalRemoteControlStateCode : CE......

EmployeejobCode : CEjobTitleName : SCjobClassCode : CEsalaryTypeCode : CE...

LivingSubjectadministrativeGenderCode : CE...bir thTime : TSdeceasedInd : BLdeceasedTime : TS...

Mater ialformCode : CE...

LicensedEntityrecertificationTime : TS...Place

mobileInd : BLaddr : ADdirectionsText : ED......

ManufacturedMater iallotNumberText : ST...

NonPersonLivingSubject...

Patient...

Organization...

Account

...

Person

addr : BAG<AD>...mar italStatusCode : CE......

WorkingList

ownershipLevelCode : CE...

PublicHealthCase

...

PatientEncounterpreAdmitTestInd : BLadmissionReferralSourceCode : CElengthOfStayQuantity : PQdischargeDispositionCode : CEspecialCourtesiesCode : SET<CE>...

Other

Acts

Infrastructure (Structured documents)

HEALTH LEVEL 7 REFERENCE INFORMATION MODEL VERSION 1.23 (RIM_0123)

Reflects changes to RIM in RIM Harmonization Meeting 03/20/2003.

Bi l l board produced by:Rochest er O ut door Advert i si ng

Roles

DiagnosticImage

subjectOrientationCode : CE...

QueryAck

...

QueryContinuation

...

Table

summary : ST......

TableStructure

...

TableColumnStructure

span :

TableCell

scope : CS...

LocalAttr

...

LocalMarkup

...

LinkHtml

...

ContextStructure

localId : ST

Infrastructure (Structured documents)

Infrastructure (Communications)

Enitites

Message Control

FinancialTransaction

...

InvoiceElement

modifierCode : SET<CE>......

FinancialContract

paymentTermsCode : CE...

RoleHeir

EntityHeir

SortControlsequenceNumber : INT......

QuerySpecmodifyCode : CSresponseElementGroupId : SET<II>...responseModalityCode : CSresponsePrior ityCode : CS...

0..n

1

0..n

1

RelationalExpression

...

QueryBySelectionSelectionExpression

0..n

1

0..n

1

LogicalExpression

relationalConjunctionCode : CS...

0..n

0..1

user AsRight

0..n

r ightSide 0..1

0..n

0..1

user AsLeft0..n

leftSide0..1

QueryByParameter

ParameterList

Parameter

id : II0..n 0..10..n 0..1

0..1

0..n

0..1

0..n

Parameter Item

...

DeviceTask

parameterValue : LIST<ANY>...

ManagedParticipation...

ActHeir

ActRelationship

typeCode : CSinversionInd : BL...contextControlCode : CS...contextConductionInd : BL......

Act

classCode : CSmoodCode : CSid : SET<II>code : CDnegationInd : BLderivationExpr : ST......

0. . n1

inboundRelat ionship

0. . n

t ar get

1

0. . n1

out boundRelat ionship

0. . n

sour ce

1

ParticipationtypeCode : CSfunctionCode : CDcontextControlCode : CSsequenceNumber : INTnegationInd : BLnoteText : EDtime : IVL<TS>modeCode : CE...

0. . n1

0. . n1

RoleLink...

RoleclassCode : CSid : SET<II>code : CEnegationInd : BLaddr : BAG<AD>telecom : BAG<TEL>statusCode : SET<CS>...

0. . n1

0. . n1

0. . n1

out boundLink

0. . n

sour ce

1

0. . n1

inboundLink

0. . n

t ar get

1

LanguageCommunicationlanguageCode : CEmodeCode : CE...

AttentionLine...

BatchreferenceControlId : IIname : SC...

EntityclassCode : CSdeterminerCode : CSid : SET<II>code : CEquantity : SET<PQ>name : BAG<EN>desc : EDstatusCode : SET<CS>...

0. . n0. . 1

playedRole

0. . n

player

0. . 1

0. . n0. . 1

scopedRole

0. . n

scoper

0. . 1

10..n 10..n

Transmissionid : II...

0..n

1

0..n

1

0..1

0..n

0..1

0..n

CommunicationFunction

typeCode : CStelecom : TEL

1..n

0..*

1..n

0..*1..*

0..*

1..*

0..* InfrastructureRoot

...QueryEvent

...

ControlAct

...

0..1

1

0..1

1

MessageversionId : STinteractionId : IIprofileId : SET<II>processingCode : CSprocessingModeCode : CSacceptAckCode : CSapplicationAckCode : CS...

0. . 1

0. . n

0. . 1

payload

0. . n

Acknowledgement

...

0. . n

1

ack nowledgedBy0. . n

acknowledges1

0. . 1

1

conveyedAcknowledgem ent0. . 1

conveyingM essage1

AcknowledgementDetail

...

1

0..n

1

0..n

11

11

Domain Related

Infrastructure Related Structured Documents

HL7 v3 Components and Process: RIM - Domain Related Classes


RIM Backbone Classes

A physical thing, group of physical things or an organization capable of participating in Acts, while in a role.

A physical thing, group of physical things or an organization capable of participating in Acts, while in a role.

A record of something that is being done, has been done, can be done, or is intended or requested to be done.

A record of something that is being done, has been done, can be done, or is intended or requested to be done.

A competency of the Entity playing the Role as identified, defined, guaranteed, or acknowledged by the Entity that Scopes the Role.

A competency of the Entity playing the Role as identified, defined, guaranteed, or acknowledged by the Entity that Scopes the Role.

An association between an Act and a Role with an Entity playing that Role. Each Entity (in a Role) involved in an Act in a certain way is linked to the act by one Participation-instance.

An association between an Act and a Role with an Entity playing that Role. Each Entity (in a Role) involved in an Act in a certain way is linked to the act by one Participation-instance.

Entity Role Participation Act

A connection between two roles expressing a dependency between those roles.

A connection between two roles expressing a dependency between those roles.

A directed association between a source act and a target act.

A directed association between a source act and a target act.

Role Link Act Relationship

0..n1

0..n 0..n

1

0..1

0..n

0..n 0..n0..n 0..n

0..1

Classes are color coded:– Green = Entity, Yellow = Role, Blue = Participation, Red/Pink = Act, Purple =

Infrastructure, Lilac = message controller.

Acts connect to Entities in their Roles through Participations, but can also connect to other Acts through Act Relationships.

HL7 v3 Components and Process: RIM UML Instance Scenario

Classes are color coded:– Green = Entity, Yellow = Role, Blue = Participation, Red/Pink = Act, Purple =

Infrastructure, Lilac = message controller.

John DoeJohn Doe PatientPatient SubjectSubject

Entity Role Participation Act

Dr. SmithDr. SmithHealthCare

ProviderHealthCare

ProviderSurgeonSurgeon

John DoeJohn Doe PatientPatient SubjectSubject

Has Pertinent Information

Has Pertinent InformationAct Relationship

(Clinical Trial Act)

Protocol ECOG 1112

(Clinical Trial Act)

Protocol ECOG 1112

XYZ Hospital

XYZ Hospital

HealthCareFacility

HealthCareFacility

LocationLocation

(Procedure Act)

Prostectomy(Procedure Act)

Prostectomy

HL7 v3 Components and Process: Domain Related Classes of the RIM…

RIM Entity Classes


RIM Backbone Class: Entity

classCode : CS

determinerCode : CS

id : SET<II>code : CE

quantity : SET<PQ>name : BAG<EN>desc : EDstatusCode : SET<CS>

existenceTime : IVL<TS>telecom : BAG<TEL>riskCode : CE

handlingCode : CE

Entity

Entity: – a person, animal, organization or

thing– A collection of classes related to the

Entity class, its specializations and related qualifying classes. The classes represent health care stakeholders and other things of interest to health care.

Entity has the following sub-classes:– Container– Device– LanguageCommunication– LivingSubject– ManufacturedMaterial– Material– NonPersonLivingSubject– Organization– Person– Place

RIM Role Classes



RIM Backbone Class: Role Roles: – A responsibility or part played by

an entity (e.g. Person in a role of patient, employee, etc.) –different faces of an Entity

– A collection of classes related to the Role class and its specializations. These classes focus on the roles participants may play in health care.

Role has the following sub-classes:– Access– Employee– LicensedEntity– Patient

classCode : CS

id : SET<II>code : CEnegationInd : BL

addr : BAG<AD>

telecom : BAG<TEL>statusCode : SET<CS>effectiveTime : IVL<TS>

certificateText : ED

quantity : RTO

positionNumber : LIST<INT>

RIM Participation and Act Classes



RIM Backbone Class: Participation

Participation: – An association between an Act and a

Role with an Entity playing that Role.

Participation has the following sub-class:– ManagedParticipation

Participation

typeCode : CSfunctionCode : CDcontextControlCode : CSsequenceNumber : INTnegationInd : BLnoteText : EDtime : IVL<TS>modeCode : CEawarenessCode : CEsignatureCode : CE

signatureText : EDperformInd : BLsubstitutionConditionCode : CE

Act: A collection of classes including the Act class and its specializations. These relate to the actions and events that constitute health care services. A record of something that is being done, has been done, can be done, or is intended

or requested to be done.

Act has the following sub-classes:– Account

– ControlAct

– DeviceTask

– DiagnosticImage

– Diet

– FinancialContract

– FinancialTransaction

– InvoiceElement


RIM Backbone Class: ActAct

classCode : CS

moodCode : CS

id : SET<II>code : CDnegationInd : BLderivationExpr : ST

text : EDtitle : STstatusCode : SET<CS>effectiveTime : GTS

activityTime : GTS

availabilityTime : TSpriorityCode : SET<CE>confidentialityCode : SET<CE>repeatNumber : IVL<INT>interruptibleInd : BLlevelCode : CEindependentInd : BL

uncertaintyCode : CEreasonCode : SET<CE>languageCode : CE

– Observation

– Participation

– PatientEncounter

– Procedure

– PublicHealthCase

– SubstanceAdministration

– Supply

– WorkingList

Note: Sub-classes also include Core Infrastructure, Message Communications Control and Structured Documents classes not shown here.

HL7 v3 Components and Process: Domain Related Classes of the RIM

ActRelationship:– A directed association

between a source Act and a target Act. A point from a later instance to a earlier instance OR point from collector instance to component instance.

ActRelationship has no sub-classes.

RIM Backbone Class: ActRelationship

inboundRelationship

ActRelationship

typeCode : CSinversionInd : BL

contextControlCode : CS

contextConductionInd : BL

sequenceNumber : INTpriorityNumber : INTpauseQuantity : PQ

checkpointCode : CS

splitCode : CSjoinCode : CSnegationInd : BLconjunctionCode : CS

localVariableName : ST

seperatableInd : BL

Act

0..n

0..n

source

0..n

target1

outboundRelationship

HL7 v3 Components and Process: HL7 v3 Process & Artifacts Overview

RIM DMIM RMIM

1..* 1..*

1..*HMD MT

1..*

DMIM – Domain Message Information Model; RMIM- Refined Message Information Model; HMD – Hierarchical Message Description; MT – Message Type


Domain Message Information Model (DMIM)

Example: PRPA_DM201101UV01

A DMIM is a refined subset of the RIM that includes a set of class clones, attributes and relationships that can be used to create messages for a particular domain (a particular area of interest in healthcare).

This is the DMIM for the Patient Administration Domain


Refined Message Information Model (RMIM)

Example: PRPA_RM201101UV01

The RMIM is a subset of a DMIM that is used to express the information content for a message or set of messages with annotations and refinements that are message specific.

This is the RMIM for the PatientLivingSubject Event Activate


Hierarchical Message Definition (HMD)

Example: PRPA_HD201101UV01

An HMD is a serialized version of the RMIM in a specific order.

This is the HMD for the PatientLivingSubject Event Activate


Message Type (MT)

Example: PRPA_MT201101UV01

A Message specification is a set of rules for constructing a message given a specific set of instance data

This is the XML schema for the PatientLivingSubject Event Activate message


Introduction to Data Types…

Data types are the basic building blocks of attributes

Data types define the meaning (semantics) of data values that can be assigned to a data element

Meaningful exchange of data requires that we know the definition of the values exchanged

Every attribute in the RIM is associated with one and only one data type, and each data type is associated with zero or many attributes

Data types in HL7 v3 are complex:– Each data type has attributes– Each data type attribute has a data type of its own

HL7 v3 Components and Process: Introduction to Data Types…

HL7 v3 has published a data type specification and supports 42 data types

First example of a complex data type:

<lengthOfStayQuantity value=“10”unit=“hours"/>

Physical Quantity (PQ) example

The attributes ‘value’ and ‘unit’ are part of the complex data type Physical Quantity (PQ). Value is expressed as the data type of integer (int).

Second Example of a complex data type: Coded Data type (CE, CD, CS, etc.)

<raceCode code=“1002-5” codeSystem= “2.16.840.1.113883.5.104” codeSystemName=“HL7 Race Vocabulary Domain" displayName=“American Indian or Alaska Native" codeSystemVersion=“3.0” />

HL7 v3 Components and Process: Introduction to Data Types


Structural Attributes and Vocabulary

An Act of the Class Observation (OBS) with a Mood of Event (EVN).

classCode and moodCode are both Structural Attributes.

Structural attributes/elements are used to specify the type and state of each RIM class and what it means when used in a message.

Structural attributes/elements use a standard vocabulary defined and controlled by the HL7 organization.


External or User-Defined Vocabulary

User-defined vocabulary is not controlled by the HL7 organization.

This typically involves domain related vocabulary.

Some examples of user-defined vocabulary:– For capturing Observations:

LOINC, SNOMED, etc.– For Adverse Events:

MedDRA, CTC, etc.– caDSR/EVS


Any Questions?

Reference Information Model (RIM)

Structured Process Components (DMIM, RMIM, HMD and MT)

Data Types

HL7 and User-defined Vocabulary

HL7 v3 Interoperability and caBIG™

In this lesson, we will:– Explain why HL7 and HL7 v3 are used at NCI CBIIT– Discuss how caAdapter supports NCI CBIIT and caBIGTM goals of

interoperability– Explain NCI CBIIT’s Clinical Architecture

HL7 v3 Interoperability and caBIG™:

The Role of HL7 and HL7 v3 at NCI CBIIT

Nine out of ten US hospitals have implemented some version of 2.x HL7 messages. – Therefore, Health and Human Service (HHS) has recommended

HL7 as the messaging standard for the electronic exchange of clinical data.

A goal of NCI CBIIT is to accelerate discovery through the synthesis of different types of cancer research data, thus facilitating translational research (combination of different disciplines of research).

Support for translational research requires integration of research data with clinical data at a semantic level. – Only then can it yield semantically computable data.

HL7 v3 offers the syntactic and semantic interoperability to make this integration possible.


caAdapter and the caBIG™ Principles…

caAdapter supports NCI CBIIT and caBIG™ principles of:– Open source– Open access– Standards based– Open development– Collaboration with other intiatives– Provides a toolset to support a federation of data sources


caAdapter and the caBIG™ Principles…

caAdapter (formerly called the HL7 SDK) is an open source tool that facilitates HL7 v3 message building, parsing and validation based on specific message definitions.

caAdapter has leveraged HL7 Java Special Interest Group (SIG) work and built new enhancements.

caAdapter provides the capability to perform vocabulary validation of core structural attributes through integration with NCI CBIIT caCORE components, such as the Enterprise Vocabulary System (EVS).


The Clinical Architecture Vision

HL7 v3 is a potential data exchange solution within the NCI CBIIT Clinical Architecture Vision.

CSM


The Clinical Architecture Vision…

caAdapter – Toolset which facilitates v3 message building, parsing and validation. caAdapter provides Comma Separated Values (CSV) and Excel files to HL7 v3 conversion capability.

Message Exchange – Service supporting message transmission and routing

HL7 Transactional Database – HL7 RIM based transactional database and data access service

De-identification Service – De-identifies patient information from HL7 v3 messages

Research Application – CMAP (Cancer Molecular Analysis Program) use case for demonstration purposes

Cancer Data Standards Repository (caDSR) – Shared metadata repository

Enterprise Vocabulary Services (EVS) – Vocabulary service for hosting controlled vocabulary, including HL7 v3 structural terminology


Any Questions?

Why HL7 and HL7 v3 are used at NCI CBIIT

How caAdapter supports NCI CBIIT and caBIGTM goals of interoperability

The NCI CBIIT Clinical Trials Architecture

Introduction to caAdapter

In this lesson, we will:– Discuss the usage of caAdapter– Describe the components of caAdapter– Illustrate how caAdapter works

Introduction to caAdapter:

Usage of caAdapter

caAdapter is a tool set that facilitates HL7 v3 message building, parsing, as well as some validation.

It has a component based architecture that supports HL7 v3 message generation.

It provides a mechanism to convert clinical data from legacy data sources to HL7 v3 messages.

caAdapter provides a user interface that can help cancer centers transform their clinical data into HL7 v3 messages and help them achieve the goal of interoperability.


Using caAdapter…

Assuming your data is in a non-HL7 v3 file format, how can you take advantage of HL7 v3’s capabilities right now? – By converting your comma separated value (.csv) files to the

proper HL7 v3 format using caAdapter


The Organization of caAdapter

caAdapter has a component based architecture that offers a tool set to support HL7 v3 message generation.

It accomplishes this via two major components:– The Core Engine– The Mapping Tool


Introduction to the Core Engine

The Core Engine– A Java based API to HL7 v3 RIM components (such as RIM

classes)– HL7 Data Type classes – Other supporting classes – A Utility Package to support HL7 v3 message building and parsing– Additional services of vocabulary validation

Introduction to caAdapter:Introduction to the Mapping Tool

The Mapping Tool component:– Has a GUI based front-end application for mapping clinical data to

HL7 v3 specifications – Has a user-friendly drag-and-drop interface– Provides some data transformation functions

caAdapter Introduction:

How the Mapping Tool Works…

Transformation (APIs)

Mapping Tool

Clinical Data

Source Data

(CSV)

HL7 v3 XML

CDMS


How the Mapping Tool Works

Source Data

(CSV)

1



Mapping ToolCDMS

Source Data

(CSV)

1

2a 2b

Source Specification

2




Any Questions?

Discussed the usage of caAdapter

Explained the components of caAdapter

Described how caAdapter works

caAdapter Architecture and Capabilities

In this Lesson, we will:– Describe the architecture and features of the Core Engine

component– Describe the architecture and features of the Mapping Tool

component– List the four main functions and sub-functions of caAdapter

caAdapter Architecture and Capabilities:

caAdapter Core Engine Features

HL7 v3 Message Parser

– Parses HL7 v3 messages to RIM object graph

HL7 v3 Message Builder

– Builds HL7 v3 messages from the RIM object graph

HL7 v3 Artifacts

– Implements RIM objects, data types and metadata objects

Metadata Loader

– Represents HL7 v3 metadata in-memory

Validation Services

– Using HL7 v3 specifications

caApapter API

– Uses mappings to generate HL7 v3 messages


caAdapter Mapping Tool Features

The Mapping Tool– Graphical application for mapping clinical data to an HL7 v3

message

Source and Target Specification– Graphical interface for defining input and output data formats

Drag and Drop Interface – Simple interface for mapping source fields to target elements

Mapping Functions– Capability to do simple source data manipulation

XML Transformer– Generation of XML message instances from source data based on

the mapping


Main functions and Sub-functions

The four main functions of caAdapter are:– Defining source specification– Defining target specification– Defining mapping specification– Converting source data to target data format

Each of these four functions has four sub-functions for handling data:– Creating– Saving– Editing– Validating


Any Questions?

The features of the Core Engine component

The features of the Mapping Tool component

The four main functions and sub-functions of caAdapter

Session Review

Now that you have successfully completed this session, you should be able to:– Provide an introduction to HL7, HL7 v2, and HL7 v3– Discuss what HL7 v3 is and how it works– Explain why HL7 v3 is used at NCI CBIIT and in caBIG™– Describe what caAdapter is and how it works

Additional Sources of Information…

Follow on Training– caAdapter Fundamentals

Health Level Seven – www.hl7.org

HL7 Reference Information Model – https://www.hl7.org/library/data-model/RIM/C30202/rim.htm

HL7 Vocabulary Domains – http://www.hl7.org/library/data-model/RIM/C30123/vocabulary.htm

HL7 v3 Standard – http://www.hl7.org/v3ballot/html/welcome/environment/index.htm

Additional Sources of Information

NCI CBIIT caAdapter Site– http://ncicb.nci.nih.gov/NCICB/infrastructure/cacore_overview/caa

dapter

HL7 v3: – “Driving Interoperability & Transforming Healthcare Information

Management” by Charles Mead, MD, MSc.– http://www.healthcare-informatics.com/webinars/05_20_04.htm

caAdapter Contacts– http://trials.nci.nih.gov/projects/infrastructureProject/caAdapter/

HLT_Tutorial

NCICB Application Support

Live Support: Monday – Friday 8 am – 8 pm Eastern Time– Telephone support is available Monday to Friday, 8 am – 8 pm

Eastern Time, excluding government holidays. – You may leave a message, send an email or submit a support

request via the Web at any time.

Email: [email protected]

Phone: 301-451-4384

Toll-free: 888-478-4423

Web: http://ncicb.nci.nih.gov/NCICB/support

HL7 v3 and caAdapter Overview 20071112

Documents

hl7 v2example hl7 v2

hl7 hl7 v3 components

hl7 organization

hl7 v3 solution hl7

hl7 v2 messages

hl7 messaging v2

problems of hl7 v2

hl7 v2 optionality