cimi reference model 1.0.11 dstu london f2f...

CIMI Modeling TaskForce / mvdzel @ results4care.nl – apr 2013

1 / 28

CIMI Reference Model1.0.11 DSTU

London F2F apr-2013Michael van der Zel

[cimi-modelling-taskforce] google groups list for general discussionshttps://groups.google.com/d/forum/cimi-modelling-taskforce

https://github.com/clinicalmodels/cimi for RM issues


4 / 28

Agenda● History● The current CIMI RM● Deliverables● GAP Analysis

– Current CIMI RM vs our Agreed RM Requirements in the RM TF Report 1.0 dd May 2012

● Timeline & Next steps


5 / 28

History


6 / 28

History● OpenEHR RM 1.5● 1.0.0 Pleasanton May 2012 - initial● 1.0.5 Rockville Sep 2012 - draft● 1.0.8 Groningen Dec 2012 - draft● 1.0.9 Scottsdale Jan 2013 – draft● 1.0.11 London Apr 2013 – DSTU!● 1.0.x When? Where? - normative


7 / 28

Guiding Principles / Rules● CIMI RM Defined in UML (using EA) and align with AML, documentation in the model,

generate document from the UML model. Should be at least available in Eclipse based and EA.

● Each element in the model should have a use-case, if not, then remove the class or attribute

● Keep in mind: serialize Models to XML, is it still comprehensible?

● From OpenEHR RM: Remove implementation / runtime classes and attributes

● Clinical Models defined using the CIMI RM are 1 Transformation Away from implementation

● Structural support is in the RM, use Patterns & Templates for Clinical Content

● CIMI RM StyleGuide

– Consistency in naming: Use singular forms, Classes UPPER_CASED with underscores, Attributes lower_cased with underscores

– Use colors for extra hints on reading the model


8 / 28

Requirements for Good Models 1. Accurate – corresponds to the real world

2. Unambiguous – only one meaning

3. Understandable – People recognize the real world referent(s)

4. Reproducible – Different modellers would model in the same way

5. Parsimonious and harmonious use of terminology – Semantics of the model and terminology match

6. Flexible – Evolve gracefully over time

7. Consistent across domains – Specimen Collection and I&O Charting

8. Practical – implementable in real systems

9. Minimally complex – cover only what is needed

10. Common queries are easy

11. Fits with available technology (OO languages) Sour

ce: 2

010

Stan

Huf

f, In

term

ount

ain

Hea

lth


9 / 28

Types of Changes● Cleanup of run-time elements● Direct associations instead of reference classes● Attribute naming consistency● Extensibility of Locatable classes● Review and simplification of the Party Model


10 / 28

The current CIMI RM


11 / 28

The Parts of the CIMI RM● The full CIMI Reference Model consists of

● Core Model● Party Model● Data Value Types● Primitive Types

Primitive Types

Data Value Types

Archetypes & Patterns

PartyModel

Dependency stack

Note that terminology / meaning binding is not in the RM. Each LOCATABLE element has an

archetype_node_id (+ tagged values in UML) and (CODED_)TEXT datatype attributes.

Core Model


12 / 28

Core Model

COMPOSITION

category :CODED_TEXTlanguage :CODED_T EXTjurisdiction :CODED_T EXT

CONTENT_ITEM

ENTRY

language :CODED_T EXT

SECTION

ARCHETYPED

archetype_id :Stringrm _version :String = 1.0.11d {readOnly}

LOCATABLE

archetype_node_id :Stringname :String

LINK

m eaning :T EXT

ITEM

ELEMENT

nul l_flavor :CODED_T EXT [0..1]value :DAT A_VALUE [0..1]

CLUSTER

structure_type :CODED_T EXT [0..1]

PARTICIPATION

function :CODED_T EXTdetai ls :IT EM [0..*]

CORE_LOCATABLEPARTY

detai ls :ITEM [0..*]

Name: CIM I Core M odelAuthor: CIM I MT FVersion: 1.0.11Created: 30-11-2012 20:32:29Updated: 10-4-2013 15:16:17

Click here for DATA_VALUE Diagram

data1..*

i tem

0..*

archetype_detai ls

0..1

sourcel ink

0..*

content 0..*

i tem

1..*

participation

0..*

party

1..1

target

1


13 / 28

Party Model

LOCATABLE

archetype_node_id :Stringnam e :String

PARTY_RELATIONSHIP

type :CODED_T EXTdetai ls :IT EM [0..*]

PARTY

detai ls :IT EM [0..*]

ROLE

type :CODED_T EXT

ACTOR

type :CODED_T EXT

Nam e: CIMI Party M odelAuthor: CIMI M T FVersion: 1.0.11Created: 25-4-2012 7:04:30Updated: 10-4-2013 10:24:37

role

0..*

sourcerela tionship

0..*target

1..1


14 / 28

Data Type ValuesYESNO

value :Boolean

DATA_VALUE

IDENTIFIER

id :Stringtype :CODED_T EXTissuer :String

ENCAPSULATED

MULTIMEDIA

al ternate_text :String [0..1]data :Byte [0..*] (Array)m edia_type :CODED_T EXTuri :URI [0..1]

PARSABLE

formal ism :CODED_T EXTvalue :String

COUNT

value :Integer

T : ORDERED_VALUE

INTERVAL_VALUE

upper_unbounded :Booleanlower_unbounded :Booleanupper_included :Booleanlower_included :Boolean

QUANTITY

value :Realuni ts :CODED_T EXTprecision :Integer [0..1]

PROPORTION

numerator :Realdenominator :Realprecision :Integer [0..1]type :CODED_T EXT

ORDINAL

sym bol :CODED_T EXTvalue :Integer

ORDERED_VALUE

QUANTIFIED

value_sta tus :String [0..1]

AMOUNT

accuracy :Real [0..1]accuracy_is_percent :Boolean [0..1]

DATE TIME

DATE_TIME

value :String

DURATION

duration_text :String [0..1 ]

TEXT

language :CODED_T EXT [0..1]

URI

CODED_TEXT

code :Stringterm inology_id :Stringterm inology_version :String [0..1]term :String [0..1]term _id :String [0..1]

EHR_URI

TERM_MAPPING

m atch :Characterpurpose :CODED_T EXT [0..1]

PLAIN_TEXT

Character

TermMappingMatchEnum

>=<?

String

QuantifiedValueStatusEnum

=<><=>=~

{uni ts constrained touni ts of time}

STRING_VALUE

value :String

Nam e: CIMI Data Value T ypesAuthor: CIMI MT FVersion: 1.0.11Created: 22-3-2013 9:00:10Updated: 10-4-2013 10:23:10

lower<T >

0..1

upper<T >0..1

target 1..1

m apping0..*


15 / 28

Deliverables


16 / 28

Deliverables● CIMI RM EA Project File – “Source of Truth”● UML 2.2 (XMI 2.1) – for “Dave's Tool”, Eclipse MDHT ● BMM – for “Tom's Tool”, the ADL Workbench

– and LinkEHR Archetype Editor● Generated Model Documentation● WIP:

https://www.box.com/s/6c1tovzu657s42mv10w5


17 / 28

CIMI RM EA Project File● The RM & Model diagrams● Helping diagrams● Mappings

– HL7 RIM

– DCM to CIMI RM

– To do: other mappings (CEM, 13606, OpenEHR)


18 / 28

Choice of ...

Choice o f ...

CONTENT_ITEM

SECTION

ITEM

CLUSTER

CORE_LOCATABLE

COMPOSITION

ITEM

ELEMENT

CONTENT_ITEM

ENTRY

SECT ION has @i tem s which are SECT ION or ENT RY.

CLUST ER has @i tem s which are CLUST ER or ELEM ENT

Any concrete Class that is a LOCAT ABLE can be the Entry-Point o f a Archetype.Any concrete Class can be used in a Pattern.

• Core: COM POSIT ION, SECT ION, ENT RY, CLUST ER, ELEM ENT

• Dem ographics: PART Y_RELAT IONSHIP, ROLE, ACT OR

LOCATABLE

PARTY_RELATIONSHIP

PARTY

ROLE

PARTY

ACTOR

data

content

+role

source target

Entry Points


19 / 28

CIM I RM

HL7 RIM

Entity

LOCATABLE

PARTY_RELATIONSHIP

LOCATABLE

PARTY

ROLEACTORLOCATABLE

PARTICIPATION

LOCATABLE

CORE_LOCATABLE

Role Participation Act

RoleLink

Backbone mapping CIMI RM to HL7 RIM

ActRelationship

{only when PART Ytypeof ROLE}

scoper

+source +relationship0..*

player

+role

0..*

+target 1..1

+participation

0..*

+party

1..1


20 / 28

Eclipse Dynagrams


21 / 28

GAP Analysis


22 / 28

GAP Analysis● Current CIMI RM vs our Agreed RM Requirements in

the RM TF Report 1.0 dd May 2012● See CIMI RM Initial Requirements GAP Analysis.xls

Reqs Ok

General Technical Requirements 11 10 91%

General Governance Requirements 3 2 67%

Structural Requirements 8 7 88%

Information Pattern Requirements 3 3 100%

Terminology Binding Requirements *) 6 5 83%

Data Type Requirements 16 14 88%

47 41 87%

* Divered to Archetype


23 / 28

Timeline & Next steps


24 / 28

apr-2013

1.0.0 - Plea

sonton (O

penEHR RM 1.5) in

itial

may-2012

1.0.11 – London DSTU

harmonize & cleanup

BMM & AWB

formalize models in AWB

documentation of the CIMI RMalign with glossary

1.0.x – norm

ative

Timeline

AML versi

on

AML Tooling- MDHT- EA (future)


25 / 28

Next Steps● Complete Model Documentation & align w/ Glossary● Write Guidance● Further implement RM in Tooling● Freeze the CIMI RM (DSTU) and formalize Archetypes

in the Tooling & identify RM issues● Motion: To freeze the current CIMI RM (DSTU) 1.0.11

and accumulate any issues we have until the normative version


26 / 28

Optional


27 / 28

Model Metrics● CIMI RM UML Model Metrics● Publications

– UML Class Diagram Metrics Tool – IEEE 2009

– A Survey of Metrics for UML Class Diagrams – JOT 2005● Tool http://www.sdmetrics.com/


28 / 28

Class Metrics


29 / 28

Package MetricsCore

Party

Data Type Value


30 / 28

Compare Data Types

CIMI Data Type Value OpenEHR data_types

cimi reference model 1.0.11 dstu london f2f...

Documents