HL7 Development Framework Tutorial

1. HL7 Development Framework Tutorial Abdul-Malik Shakir Principal Consultant, Shakir Consulting October 1, 2002

2. Session Overview • HL7 Development Framework Project • Project Introduction • Project Background • Project Scope and Objectives • Project Accomplishments • Project Next Steps • HL7 Development Framework Metamodel • UML 2.0 Metamodel • UML Metamodel Extension Mechanisms • HL7 MDF Metamodel • HDF Metamodel and Profile • HL7 Development Framework Methodology • MDF Methodology • HDF Methodology HL7 Development Framework Tutorial

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

4. 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 mapping to the UML metamodel • To introduce the HDF methodology and its relationship to the MDF methodology • To encourage your participation in designing and developing the HDF methodology. HL7 Development Framework Tutorial

5. HL7 Development Framework Project • Project Introduction • Project Background • Project Scope and Objectives • Project Accomplishment • Project Next Steps 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 standards specifications. • The HL7 Development Framework (HDF) project will enable HL7 to: • Maximize the benefits it derives from using the Unified Modeling Language (UML) as a foundation for its model-based approach to standards development; • Expand application of its 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; • Facilitate the participation of HL7 members, subject matter experts, and implementers in the development of HL7 standards. • The HDF project is sponsored by Health Level Seven, Inc. with partial funding from the Veterans Health Administration (VHA). • Project management is provided by Shakir Consulting. HL7 Development Framework Tutorial

7. Project Background – Health Level Seven • Health Level Seven (HL7) is an American National Standards Institute (ANSI) Accredited Standards Developer. • 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. • The standard provides the layout of messages that are exchanged between two or more applications based upon a particular trigger event. • It specifies which data elements are to be sent, the data type and suggested length of each element, and indicates whether the data element is required or optional and whether it may repeat. HL7 Development Framework Tutorial

8. Project Background – HL7 Standards • In the years since its founding, HL7 has evolved beyond traditional messaging protocols. • Today HL7 standards development initiatives include: • standardization of knowledge representation (Arden Syntax); • specification of components for context management (known as CCOW); • support for healthcare data interchange using object request brokers; • standardization of clinical document structures; • specification of robust vocabulary definitions for use in clinical messages and documents; and • work in the area of security, privacy, confidentiality, and accountability. • In 2001 HL7 modified it mission statement to specifically include standards, guidelines, methodologies, and related services for the management of electronic health records. HL7 Development Framework Tutorial

9. Project Background – HL7 V3 Methodology • In 1992 HL7 made a fundamental shift in the methodology it uses to develop its standards specifications. • The new methodology, referred to as HL7 Version 3.0 (or V3), is a model-driven methodology based upon modern object-oriented software development practices. • HL7 spent four years creating the methodology that adapts modern analysis techniques from system building to message design. • Initially the HL7 Executive Committee chartered an independent task force to establish the broad outline of the approach. • In January 1996, the Technical Steering Committee agreed to adopt the main features of the approach and take over its management. • Planning work continued in the Modeling and Methodology Technical Committee. • In the spring of 1997, all the HL7 Technical Committees began to use the V3 process. HL7 Development Framework Tutorial

10. Project Background – HL7 V3 Messaging Standard • Balloting on an initial set of V3 message specifications began in August 2001. • This first set of V3 messages provide comprehensive coverage of patient administration, laboratory and pharmacy orders, medical records management, and initial proposals for scheduling. • A new set of electronic claims messages support a contingent of HL7 international affiliates now working on creating financial transactions to support an e-claims submission process. • The HL7 Version 3.0 development methodology is a continuously evolving process that seeks to develop specifications that facilitate interoperability between healthcare systems. • The HL7 Reference Information Model (RIM), vocabulary specifications, and model-driven process of analysis and design combine to make HL7 Version 3.0 an exemplary methodology for development of consensus-based standards for healthcare information system interoperability. HL7 Development Framework Tutorial

11. Project Background – Unified Modeling Language • The models used in the HL7 V3 process are based upon the Unified Modeling Language (UML). • The UML is a graphical language for visualizing, specifying, constructing, and documenting the artifacts of a software-intensive system. • The 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

12. Project Background – UML v2.0 • The current version of the UML specification (v1.4) was published in September 2001. • Under the stewardship of the OMG, the UML has emerged as the software industry’s dominant modeling language. • It has been successfully applied to a wide range of domains, ranging from health and finance to aerospace. • Its extensive use has raised numerous application and implementation issues by modelers and vendors. • Over 500 formal usage and implementation issues have been submitted to the OMG for consideration. • Many of the issues have been resolved in minor revisions by the OMG UML Revision Task Force. • Other issues require major changes to the language; consequently, the OMG has issued RFPs to define UML 2.0. HL7 Development Framework Tutorial

13. Project Background – XMI and MOF • The UML is part of OMG’s catalog of modeling specifications. Other OMG modeling specifications with relevance to the HDF project include the XML Meta-Data Interchange (XMI) and the Meta-Object Facility (MOF) specifications. • XMI is a specification enabling easy interchange of metadata between modeling tools and metadata repositories in distributed heterogeneous environments. • The OMG XMI specification leverages XML (eXtensible Markup Language) technology to support the interchange of meta-data and meta-models between MOF-based meta-data repositories. • The MOF is a set of standard interfaces used to define and manipulate a set of interoperable metamodels and their corresponding models. It provides a framework that supports the management of metadata. • The MOF is based upon a four layer meta-modeling architecture. The key feature of this architecture is a meta-meta-modeling layer which provides a common language that defines the meta-models. HL7 Development Framework Tutorial

14. Project Background – HL7 MDF • The HL7 Message Development Framework (MDF) defines the HL7 V3 model-based process of message development. • It identifies the phases, activities, and models used in the process of developing HL7 message specifications. • It also includes a meta-model specification of the Reference Model Repository (RMR) used to store and manage the artifacts produced during the message development process. • 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. • The HL7 Message Development Framework will be superceded by the HL7 Development Framework, the HDF. HL7 Development Framework Tutorial

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

16. Project Background – HL7 Development Framework • The HL7 Development Framework (HDF) is a replacement for and an extension to the HL7 Message Development Framework (MDF). • The HDF differs from the MDF in terms of: • Scope of Coverage • Alignment with UML • Maintenance/versioning Procedures • Companion documents to the HDF are: • The HDF Metamodel Specification • The HDF Practical Guide HL7 Development Framework Tutorial

17. Project Scope and Objectives • Project Scope: • Develop and publish the HDF Metamodel • Develop and publish the initial version of the HDF • Develop a preliminary draft of the HDF Practical Guide • Project Objectives: • Maximize the benefits HL7 derives from using UML as a foundation for its model-based approach to standards development. • Expand the modeled-based approach for standards development beyond the HL7 messaging standard. • 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

18. HDF Project Accomplishments • Project Administration • Project initiation • Project Planning • Project monitoring and status reporting • HDF Metamodel • Collect Relevant Metamodel Documentation • Compare MDF and UML Metamodels • Prepare HDF Metamodel and UML Profile • HDF Methodology • Identified HDF Methodology Lifecycle • Identified HDF Methodology Deliverables • Began preparation of the HDF Methodology Specification • HDF Practical Guide • Prepared HDF Tutorial • Began preparation of the HDF Practical Guide Document HL7 Development Framework Tutorial

19. HDF Project Next Steps • Project Administration • Phase II Project initiation • Phase II Project Planning • HDF Metamodel • Peer review of the HDF Metamodel specification • Consideration of the UML v2.0 proposal • Examination of the HDF Metamodel tooling implications • HDF Methodology • Completion of v1.0 of the HDF Methodology Specification • Peer review of the HDF Methodology Specification • Consideration of the UN/CEFACT Unified Modeling Methodology • HDF Practical Guide • Examination of the HDF Methodology education and training implications • Completion of v1.0 of the HDF Practical Guide Document • Peer review of the HDF Practical Guide Document HL7 Development Framework Tutorial

20. Questions Abdul-Malik Shakir Principal Consultant Shakir Consulting 1911 Foothill Blvd., Suite 148 La Verne, CA 91750 Office: (909) 596-6790 Mobile: (626) 644-4491 Email: ShakirConsulting@cs.com HL7 Development Framework Tutorial

21. HL7 Development Framework Metamodel • UML 2.0 Metamodel • UML Metamodel Extension Mechanisms ----- Cookie Break ----- • HL7 MDF Metamodel • HDF Metamodel and Profile HL7 Development Framework Tutorial

22. Four Layer Meta-data Architecture • M0: The user object layer The user object layer is comprised of the information to be described. This information is typically referred to as “data.” • M1: The model layer The model layer is comprised of the meta-data that describes information in the user object layer. • M2: The meta-model layer The meta-model layer is comprised of the descriptions (i.e., meta-meta-data) that define the structure and semantics of meta-data. It is the “language” used in the construction of models. • M3: The meta-meta-model layer The meta-meta-model layer is comprised of the description of the structure and semantics of meta-meta-data. In other words, it is the “language” used in the construction of meta-models. HL7 Development Framework Tutorial

23. Implementer’sView End-User’s View One Person’s Model is the Next Person’s Metamodel MOF UML HDF HL7 Model HL7 Spec. HL7 Impl. Health Data Standards Developer’sView M3 M3 M3 M3 M2 M2 M2 M2 M1 M1 M1 M1 M0 M0 M0 M0 Methodologist’s View HL7 Development Framework Tutorial

24. Methodologist View • M0: The HL7 Reference Information Model and Domain Specific Design Information Models are example of HL7 models. • M1: The HDF Metamodel is a collection of model elements that describe the structure, semantics, and constraints of the elements in a well-formed HL7 model. • M2: The UML Metamodel is a description of the structure, semantics, and constraints of elements in the HDF Metamodel. • M3: MOF is a description of the structure, semantics, and constraints of elements in the UML Metamodel. HL7 Development Framework Tutorial

25. Standard Developer View • M0: The HL7 v3.0 Laboratory Message Specification is an example of an HL7 standard specification • M1: The HL7 Reference Information Model and Domain Specific Design Information Models are example of HL7 models. They describe the semantics and constraints of elements in an HL7 standard. • M2: The HDF Metamodel is a collection of model elements that describe the structure, semantics, and constraints of the elements in a well-formed HL7 model. • M3: The UML Metamodel is a description of the structure, semantics, and constraints of elements in the HDF Metamodel. HL7 Development Framework Tutorial

26. The HDF Metamodel • This presentation of the HDF metamodel takes the methodologist view. • The HDF metamodel defines the structure, semantics, and constraints for elements used in creating well-formed HL7 models. • The content of the HDF metamodel is derived from the UML metamodel and takes advantage of the extension mechanisms defined by UML. • The UML metamodel is the HDF’s meta-model. The meta-meta-model for HL7 models. • Later in this presentation, when describing the HDF methodology, the perspective will shift to the standards developer’s view. • In the standards developer’s view the HL7 models are the metamodels for well formed HL7 standard specifications and the HDF metamodel is the meta-meta-model. HL7 Development Framework Tutorial

27. UML Metamodel • Foundation • Core • Extension Mechanisms • Datatypes • Behavior Elements • Common Behavior • Collaborations • Use Cases • State Machines • Activity Graphs • Model Management • Package • Subsystem • Model HL7 Development Framework Tutorial

28. UML Metamodel • Foundation • Core • Extension Mechanisms • Datatypes • Behavior Elements • Common Behavior • Collaborations • Use Cases • State Machines • Activity Graphs • Model Management • Package • Subsystem • Model HL7 Development Framework Tutorial

29. UML Metamodel Packages HL7 Development Framework Tutorial

30. UML Metamodel - Core • Backbone • Classifiers • Dependencies • Relationships • Auxilary Elements HL7 Development Framework Tutorial

31. UML Metamodel – Core Backbone HL7 Development Framework Tutorial

32. UML Metamodel – Core Classifiers HL7 Development Framework Tutorial

33. UML Metamodel – Core Relationship HL7 Development Framework Tutorial

34. UML Metamodel – Use Case HL7 Development Framework Tutorial

35. UML Metamodel – State Machine HL7 Development Framework Tutorial

36. UML Metamodel – Model Management HL7 Development Framework Tutorial

37. UML Metamodel - Extension Mechanisms HL7 Development Framework Tutorial

38. 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

39. Cookie Break – 30 Minutes HL7 Development Framework Tutorial

40. HDF Development Process HL7 Development Framework Tutorial

41. 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. • Proposed revisions to the Vocabulary model portion of the MDF metamodel are being developed by the Vocabulary Technical Committee. • An preliminary version of the proposed vocabulary portion of the MDF metamodel was formally reviewed by the Modeling and Methodology Technical Committee in July 2002. • The HDF Metamodel is base upon a comparison of the UML metamodel to v1.16 of the MDF metamodel ( including the proposed revisions to the vocabulary portion). HL7 Development Framework Tutorial

42. Packages of the HL7 MDF Metamodel • Model Identification and Scope • Use Case Model • Information Model • Datatype Model • Vocabulary Domain Model • Design Information Model • Hierarchical Message Description • Interaction Model HL7 Development Framework Tutorial

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

44. HDF: Model Identification and Packaging HL7 Development Framework Tutorial

45. MDF: Use Case Model HL7 Development Framework Tutorial

46. HDF: Use Case Model HL7 Development Framework Tutorial

47. MDF: Information Model HL7 Development Framework Tutorial

48. HDF: Information Model ~ Class/Attribute HL7 Development Framework Tutorial

49. HDF: Information Model ~ Relationship HL7 Development Framework Tutorial

50. HDF: Information Model ~ States HL7 Development Framework Tutorial