HL7 Development Framework Tutorial

1. HL7 Development Framework Tutorial Abdul-Malik Shakir Principal Consultant, Shakir Consulting April 2003

2. My HL7 Background Abdul-Malik Shakir Principal Consultant, Shakir Consulting, La Verne, CA HL7 Member since 1991 • Member of the HL7 Board of Directors • Chair of the Education and Implementation Committee • Member of the Architectural Review Board • Member of the Process Improvement Committee • Co-Chair of the Modeling and Methodology Committee • Project Manager for the HL7 Development Framework Project HL7 Development Framework Tutorial

3. Session Objectives • To raise awareness of the HL7 Development Framework (HDF) project. • To summarize the accomplishments and remaining planned activities of the HDF project. • To introduce the HDF metamodel and its relationship to the UML metamodel • To introduce the HDF methodology and its relationship to the MDF methodology • To encourage your participation in designing and deploying the HDF methodology. HL7 Development Framework Tutorial

4. Session Overview • Session I • HL7 Development Framework Project • Unified Modeling Language Metamodel • HDF UML Profile and Metamodel • HDF Model Interchange Format • Session II • HL7 Message Development Framework • HDF Development Methodology • HDF Pilot Projects • HDF Developer’s Guide • HDF Transition Planning HL7 Development Framework Tutorial

5. HL7 Development Framework Project HL7 Development Framework Tutorial

6. Project Introduction • The purpose of the Health Level Seven (HL7) Development Framework Project is to research, analyze, design, and document the processes, policies, and artifacts associated with development of HL7 published specifications and standards. • The HL7 Development Framework (HDF) project will: • Expand HL7’s modeled-based approach for standards development beyond messaging to its other standards such as structured documents, context management, and standards related to electronic health records; • Maximize the benefits HL7 derives from using the Unified Modeling Language (UML) as a foundation for its model-based approach to standards development; • Facilitate increased participation of HL7 members, subject matter experts, and implementers in the development of HL7 standards. • Enable HL7 to remain the industry leader in model-driven development of comprehensive standards for application interoperability in the Health industry. HL7 Development Framework Tutorial

7. Project Background – Health Level Seven • The mission of HL7 is to provide a comprehensive framework and related standards for the exchange, integration, storage, and retrieval of health information that support clinical practices and the management, delivery and evaluation of health services. • HL7 began developing standards in 1987 with the publication of its messaging specification - the Application Protocol for Electronic Data Exchange in Healthcare Environments. • In the years since its founding, HL7 has evolved beyond traditional messaging protocols to include clinical document architectures, medical logic modules, component specifications, and standards, guidelines, and related services for the management of electronic health records. HL7 Development Framework Tutorial

8. The Family of HL7 Specifications and Standards • Version 2.x and 3.x messaging specifications; • Knowledge representation and clinical decision support (Arden Syntax); • Specification of components for context management (CCOW); • Standardization of clinical document structures (CDA); • Vocabulary definitions for use in clinical messages and documents; • Standards, methodologies and services related to electronic health records (EHR); • Informative specifications in the area of security, privacy, and accountability. HL7 Development Framework Tutorial

9. Project Background – HL7 V3 Methodology • In 1992 HL7 made a fundamental shift in the method it uses to develop its specifications and standards. • The new methodology, referred to as HL7 Version 3.0 (or V3), is a model-driven standards development methodology based upon modern object-oriented software development practices. • In January 1996, the HL7 Technical Steering Committee adopted the model-driven approach and the Modeling and Methodology Technical Committee assumed primary responsibility for ongoing development of the V3 methodology. HL7 Development Framework Tutorial

10. Project Background – HL7 MDF Process Model HL7 Development Framework Tutorial

11. HL7 Message Development Framework • The HL7 Message Development Framework (MDF) defines the HL7 V3 message development process. • It identifies the phases, activities, and models used in the process of developing HL7 message specifications. • The HL7 MDF was first published in 1997. It has undergone two major revisions since then; once in 1998 and again in 1999. • The current version of the MDF (v3.3), published in December 1999, has not been maintained and is consequently out of alignment with current message development practices. HL7 Development Framework Tutorial

12. HDF Development Methodology Specification • The HDF Development Methodology Reference Manual is a replacement for and an extension to the HL7 Message Development Framework (MDF). • The HDF Development Methodology Reference Manual differs from the MDF in terms of: • Scope of Coverage • Alignment with UML • Maintenance/versioning Procedures • Companion documents to the HDF Development Methodology Reference Manual are: • The HDF Metamodel Specification • The HDF Developer’s Guide HL7 Development Framework Tutorial

13. HDF Project Scope and Objectives • Project Scope: • Develop and publish the HDF Development Methodology Reference Manual • Develop and publish the HDF UML Profile and Metamodel Specification • Develop and publish the HDF Developer’s Guide • Project Objectives: • Expand the modeled-based approach for standards development beyond the HL7 messaging standard. • Embrace the UML standard, conventions, and practices as the foundation for the HL7 model-based approach to standards development. • Facilitate the participation of HL7 members, subject matter experts, and implementers in the development of HL7 standards. • Enable HL7 to remain the industry leader in model-driven development of comprehensive standards for application interoperability in the Health industry. HL7 Development Framework Tutorial

14. HDF 2002 Accomplishments • Defined the HDF project scope and objectives • Organized project team and team member assignments • Mapped the MDF to the UML metamodel • Reconciled MDF and UML metamodel discrepancies • Used UML extension mechanisms to define an HL7 UML Profile • Established a broad outline of the HDF development process • Prepared and reviewed initial drafts of the seven chapters describing the phases of the HDF development lifecycle • Prepared and presented tutorials on the HDF at two HL7 working group meetings HL7 Development Framework Tutorial

15. HDF 2003 Objectives • Prepare phase II project charter • Obtain project approval and funding • Finalize documentation of the development lifecycle • Conduct pilots of the development process • Publish release 1 of the HDF Development Methodology Reference Manual • Publish release 2 of the HDF UML Profile and Metamodel • Publish release 1 on the HDF Model Interchange Format • Prepare an initial draft of an HDF Developer’s Guide • Establish a transition plan for the HDF process and metamodel HL7 Development Framework Tutorial

16. HDF Phase II Subproject Timelines and Task Leaders • HDF Project Planning and Management • 01/06/2003 ~ 01/05/2004 – Abdul-Malik Shakir • HDF Development Methodology Reference Manual • 01/06/2003 ~ 12/26/2003 – Abdul-Malik Shakir • HDF Metamodel and Model Interchange Format • 02/03/2003 ~ 12/26/2003 – Tony Mallia and Lloyd Mckenzie • HDF Pilot Projects • 01/06/2003 ~ 09/05/2003 – Charlie Mead • HDF Developer’s Guide • 06/23/2003 ~ 12/05/2003 – Woody Beeler • HDF Transition Planning • 06/23/2003 ~ 12/26/2003 – Mead Walker HL7 Development Framework Tutorial

17. Unified Modeling Language Metamodel HL7 Development Framework Tutorial

18. Unified Modeling Language Overview • The models used in the HL7 V3 process are based upon the Unified Modeling Language (UML). • UML is a graphical language for visualizing, specifying, constructing, and documenting the artifacts of a software-intensive system. • UML is an Object Management Group standard that represents the unification of best practices in practical object-oriented modeling. • Development of the UML began in 1994 when James Rumbaugh and Grady Booch of Rational Software Corporation began combining the concepts from the Object Modeling Technique (OMT) and Booch methods, resulting in a unified specification in 1995. • In the Fall of 1995, Ivar Jacobson joined Rational and the unification effort, merging in the Object-Oriented Software Engineering method (OOSE). • The joint work of Rumbaugh, Booch, and Jacobson was called the Unified Modeling Language (UML). HL7 Development Framework Tutorial

19. Colorado State University: Robert France Computer Associates: John Clark Concept 5 Technologies: Ed Seidewitz Data Access Corporation: Tom Digre Enea Data: Karin Palmkvist Hewlett-Packard Company: Martin Griss IBM Corporation: Steve Brodsky, Steve Cook I-Logix: Eran Gery, David Harel ICON Computing: Desmond D’Souza IntelliCorp and James Martin & Co.: James Odell Kabira Technologies: Conrad Bock Klasse Objecten: Jos Warmer MCI Systemhouse: Joaquin Miller OAO Technology Solutions: Ed Seidewitz ObjecTime Limited: John Hogg, Bran Selic Oracle Corporation: Guus Ramackers PLATINUM Technology Inc.: Dilhar DeSilva Rational Software: Grady Booch, Ed Eykholt, Ivar Jacobson, Gunnar Overgaard, Jim Rumbaugh SAP: Oliver Wiegert SOFTEAM: Philippe Desfray Sterling Software: John Cheesman, Keith Short Sun Microsystems: Peter Walker Telelogic: Cris Kobryn, Morgan Björkander Taskon: Trygve Reenskaug Unisys Corporation: Sridhar Iyengar, GK Khalsa, Don Baisley UML Core Development Team The following persons were members of the core development team for the UML proposal or served on the first or second UML Revision Task Force: HL7 Development Framework Tutorial

20. Primary Design Goals of the UML • Provide users with a ready-to-use, expressive visual modeling language to develop and exchange meaningful models. • Furnish extensibility and specialization mechanisms to extend the core concepts. • Support specifications that are independent of particular programming languages and development processes. • Provide a formal basis for understanding the modeling language. • Encourage the growth of the object tools market. • Support higher-level development concepts such as components, collaborations, frameworks and patterns. • Integrate best practices. HL7 Development Framework Tutorial

21. UML Model Views and Diagrams HL7 Development Framework Tutorial

22. UML Model Diagrams and Views • Use Case Diagram • Class Diagram • Behavior Diagrams: • State-chart Diagram • Activity Diagram • Interaction Diagrams: • Sequence Diagram • Collaboration Diagram • Implementation Diagrams: • Component Diagram • Deployment Diagram HL7 Development Framework Tutorial

23. Packages of the UML Metamodel • Foundation • Core • Datatypes • Extension Mechanisms • Behavioral Elements • Common Behavior • Collaborations • State Machines • Activity Graphs • Use Cases • Model Management HL7 Development Framework Tutorial

24. UML Metamodel - Foundation Core HL7 Development Framework Tutorial

25. UML Metamodel - Foundation Core • Models contain Model Elements including the generalizable element “Classifier”. • Classifiers have structuraland behavioral Features such as attributes, operations, and methods. HL7 Development Framework Tutorial

26. UML Metamodel – Model Management HL7 Development Framework Tutorial

27. UML Metamodel – Model Management • A Package forms a Namespace for the model Elements it owns. • A Package may import Model Elements ownedby other Packages. • A model is a type of Package. HL7 Development Framework Tutorial

28. UML Metamodel – Common Behaviors HL7 Development Framework Tutorial

29. UML Metamodel – Common Behaviors • UML Behavioral specificationsinclude a sequence of Actionswith an ordered set of Arguments. • UML Actions include create, call, return, send, terminate, destroy, and uninterpreted actions. HL7 Development Framework Tutorial

30. UML Metamodel - Extension Mechanisms HL7 Development Framework Tutorial

31. UML Metamodel - Extension Mechanisms • The UML Metatmodel isextended by using: • Stereotypes • Tag Definition • Constraints • Tagged Values. HL7 Development Framework Tutorial

32. UML Extension Mechanisms • Stereotype A stereotype is, in effect, a subclass of an existing metamodel element with the same form (attributes and relationships) but with different intent. A stereotyped element may have additional constraints on it from the base metamodel class. It may also have tagged values that add information needed by elements branded with the stereotype. • Tag Definition Tag definitions specify new kinds of properties that may be attached to model elements. The actual properties of individual model elements are specified using Tagged Values. Tag definitions are used to define the virtual meta attributes of the stereotype to which they are attached. • Stereotype Constraint Designates constraints that apply to all model elements branded by the stereotype to which they are attached. A constraint is semantic information attached to a model element that specifies conditions and propositions that must be maintained as true; otherwise, the associated model element is not well-formed. • Tagged Value A tagged value is a keyword-value pair that may be attached to any kind of model element. The keyword is called a tag. Each tag represents a particular kind of property applicable to one or many kinds of model elements. HL7 Development Framework Tutorial

33. HL7 Development Framework Metamodel HL7 Development Framework Tutorial

34. MDF Metamodel v1.16 Compare the MDF Metamodel to the UML MDF to UML Comparision HDF Metamodel Development Metamodel HDF Metamodel UML Metamodel Specification v1.4 Construct the HDF Metamodel and Profile Specification Proposed revisions to the HDF Metamodel UML vocabulary portion of the Profile Specification MDF metamodel HL7 Development Framework Tutorial

35. HL7 Message Development Framework Metamodel • The MDF metamodel v1.13 is included in the December 1999 MDF (v3.3). • The MDF metamodel was updated in August 2000 (v1.14) to include major revisions to the message design model. • The MDF metamodel was updated again in May of 2002 (v1.16) to reflect major revisions to the practice of producing design information models based upon the RIM. • The HDF Metamodel is base upon a comparison of the UML v1.4 metamodel to v1.16 of the MDF metamodel (including proposed revisions to the vocabulary portion). HL7 Development Framework Tutorial

36. Packages of the MDF Metamodel • Model Identification and Scope • Use Case Model • Reference Information Model • Information Model • Vocabulary Domain Model • Datatype Model • Message Specification Model • Design Information Model • Hierarchical Message Description • Interaction Model • Application Roles • Interactions HL7 Development Framework Tutorial

37. Packages of the UML Metamodel • Foundation • Core • Datatypes • Extension Mechanisims • Behavioral Elements • Common Behavior • Collaborations • State Machines • Activity Graphs • Use Cases • Model Management HL7 Development Framework Tutorial

38. Mapping of the MDF to UML HL7 Development Framework Tutorial

39. MDF to UML Metamodel Mapping Discrepancies • Model identification data needs to be expanded to include data needed for HL7 model management such as responsible HL7 committee and project. • Provisions are needed to address the MDF meta-classes Composite Datatype and Datatype Component. • Significant enhancements to the UML metamodel is needed to address the issue of Vocabulary domains. • The concepts introduced by MDF in the Design Information Model and Hierarchical Message Description packages are completely addressed within the UML metamodel however; significant rethinking of the jargon and processes in this area is required. • The mapping of concepts in the Interaction Portion of the MDF metamodel is fairly straight forward. Most of the conceptual difficulties come as a result of unfortunate homonyms between the two metamodels. For example, each model includes the terms Interaction but with different semantics. • The UML metamodel features used to express constraints will need to be more elaborate than a simple Boolean text expression. Constraints are a major component of any HL7 standard specification. • The MDF concepts of Receiver Responsibility and Trigger Event will need to be resolved with the overlapping concepts of Action and Event in the UML metamodel. HL7 Development Framework Tutorial

40. MDF: Model Identification and Scope HL7 Development Framework Tutorial

41. UML Metamodel – Model Management HL7 Development Framework Tutorial

42. HDF: Model Management Extensions to the UML Metamodel HL7 Development Framework Tutorial

43. The HL7 UML Profile uses the UML extension mechanisms to define HL7 stereotypes and tags. • Each HL7 Stereotype is associated with a single UML base class. • A list of Tags and Constraints is specified for each stereotype. • A definition is provided for each Tag specified for sterotypes. HL7 Development Framework Tutorial

44. UML Metamodel - Extension Mechanisms HL7 Development Framework Tutorial

45. Clone CodedValue CodeSet DataTypes DIM HL7Attribute HL7DataType HL7Model HL7ModelElement HL7Package RegisteredCodeSystem RIM UsageContext Vocabulary VocabularyDomain Stereotypes in the HL7 Profile HL7 Development Framework Tutorial

46. HDF UML Profile Stereotype Specifications HL7 Development Framework Tutorial

47. HDF UML Profile Tag Value Specifications HL7 Development Framework Tutorial

48. HDF Metamodel v1.0 UML Metamodel v1.4 HDF UML Profile v1.0 HDF Metamodel HDF Metamodel = UML Metamodel + HDF UML Profile HL7 Development Framework Tutorial

49. HDF Model InterchangeFormat HL7 Development Framework Tutorial

50. Model Interchange Requirements Rational Rose Rose Tree Model Repository Design Database / Publication Database RMIM Designer Schema Generator HL7 Development Framework Tutorial