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

HL7 Development Framework TutorialAbdul-Malik ShakirPrincipal Consultant, Shakir Consulting

October 1, 2002

HL7 Development Framework Tutorial

Session OverviewHL7 Development Framework ProjectProject IntroductionProject BackgroundProject Scope and ObjectivesProject AccomplishmentsProject Next Steps

HL7 Development Framework MetamodelUML 2.0 MetamodelUML Metamodel Extension MechanismsHL7 MDF Metamodel HDF Metamodel and Profile

HL7 Development Framework MethodologyMDF Methodology HDF Methodology


My HL7 BackgroundAbdul-Malik ShakirPrincipal Consultant, Shakir Consulting, La Verne, CA

HL7 Member since 1991

Member of the HL7 Board of DirectorsAppointed Chair of the HL7 Education and Implementation CommitteeMember of the HL7 Architectural Review BoardCo-Chair of the HL7 Modeling and Methodology Technical CommitteeProject Manager for the HL7 Development Framework Project


Session ObjectivesTo 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 metamodelTo introduce the HDF methodology and its relationship to the MDF methodologyTo encourage your participation in designing and developing the HDF methodology.


HL7 Development Framework Project

Project IntroductionProject BackgroundProject Scope and ObjectivesProject Accomplishment Project Next Steps


Project IntroductionThe 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.


Project Background Health Level SevenHealth 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.


Project Background HL7 StandardsIn 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; andwork 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.


Project Background HL7 V3 MethodologyIn 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.


Project Background HL7 V3 Messaging StandardBalloting 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.


Project Background Unified Modeling LanguageThe 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).


Project Background UML v2.0The 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 industrys 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.


Project Background XMI and MOFThe UML is part of OMGs 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.


Project Background HL7 MDFThe 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.


Project Background HL7 MDF Process Model


Project Background HL7 Development FrameworkThe 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 CoverageAlignment with UMLMaintenance/versioning ProceduresCompanion documents to the HDF are:The HDF Metamodel SpecificationThe HDF Practical Guide


Project Scope and ObjectivesProject Scope:Develop and publish the HDF MetamodelDevelop and publish the initial version of the HDFDevelop a preliminary draft of the HDF Practical GuideProject 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.


HDF Project AccomplishmentsProject AdministrationProject initiationProject PlanningProject monitoring and status reportingHDF MetamodelCollect Relevant Metamodel DocumentationCompare MDF and UML MetamodelsPrepare HDF Metamodel and UML ProfileHDF Methodology Identified HDF Methodology Lifecycle Identified HDF Methodology DeliverablesBegan preparation of the HDF Methodology SpecificationHDF Practical GuidePrepared HDF TutorialBegan preparation of the HDF Practical Guide Document


HDF Project Next StepsProject AdministrationPhase II Project initiationPhase II Project PlanningHDF MetamodelPeer review of the HDF Metamodel specificationConsideration of the UML v2.0 proposalExamination of the HDF Metamodel tooling implicationsHDF Methodology Completion of v1.0 of the HDF Methodology SpecificationPeer review of the HDF Methodology SpecificationConsideration of the UN/CEFACT Unified Modeling MethodologyHDF Practical GuideExamination of the HDF Methodology education and training implicationsCompletion of v1.0 of the HDF Practical Guide DocumentPeer review of the HDF Practical Guide Document


QuestionsAbdul-Malik ShakirPrincipal Consultant

Shakir Consulting1911 Foothill Blvd., Suite 148La Verne, CA 91750

Office: (909) 596-6790 Mobile: (626) 644-4491Email: [email protected]


HL7 Development Framework Metamodel

UML 2.0 MetamodelUML Metamodel Extension Mechanisms----- Cookie Break -----HL7 MDF Metamodel HDF Metamodel and Profile


Four Layer Meta-data ArchitectureM0: The user object layerThe 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.


One Persons Model is the Next Persons Metamodel


Methodologist ViewM0: 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.


Standard Developer ViewM0: The HL7 v3.0 Laboratory Message Specification is an example of an HL7 standard specificationM1: 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.


The HDF MetamodelThis 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 HDFs 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 developers view.In the standards developers view the HL7 models are the metamodels for well formed HL7 standard specifications and the HDF metamodel is the meta-meta-model.


UML MetamodelFoundationCoreExtension MechanismsDatatypesBehavior ElementsCommon BehaviorCollaborationsUse CasesState MachinesActivity GraphsModel ManagementPackageSubsystemModel


UML Metamodel Packages


UML Metamodel - CoreBackboneClassifiersDependenciesRelationshipsAuxilary Elements


UML Metamodel Core Backbone


UML Metamodel Core Classifiers


UML Metamodel Core Relationship


UML Metamodel Use Case


UML Metamodel State Machine


UML Metamodel Model Management


UML Metamodel - Extension Mechanisms


UML Extension MechanismsStereotypeA 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 DefinitionTag 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 ConstraintDesignates 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 ValueA 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.


Cookie Break 30 Minutes


HDF Development Process


MDF Metamodelv1.16

UML Metamodelv1.14

Compare the MDF Metamodel to the UML Metamodel

MDF to UML Comparision

Construct the HDF Metamodel and Profile Specification

Proposed revisions to the vocabulary portion of the MDF metamodel

HDF Metamodel Specification

HDF Metamodel UML Profile Specification

HL7 Message Development Framework MetamodelThe 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).


Packages of the HL7 MDF MetamodelModel Identification and ScopeUse Case ModelInformation ModelDatatype ModelVocabulary Domain ModelDesign Information ModelHierarchical Message DescriptionInteraction Model


MDF: Model Identification and Scope


HDF: Model Identification and Packaging


MDF: Use Case Model


HDF: Use Case Model


MDF: Information Model


HDF: Information Model ~ Class/Attribute


HDF: Information Model ~ Relationship


HDF: Information Model ~ States


MDF: Datatype Model


HDF: Datatype Model


MDF: Vocabulary Model (proposed)


HDF: Vocabulary Model


MDF: Design Information Model


HDF: Information Model ~ Class/Attribute


HDF UML Profile Specification


HDF Metamodel Development Next StepsThe HDF UML Profile Specification also includes complete tag definitions and stereotype constraint specifications.Additional work is required to complete the specification of the HDF UML Profile and Metamodel specification to reflect the needs of Design Information Models and Hierarchical Model Descriptions.Work on the Interaction Model portion of the HDF Metamodel and Profile will be addressed in Phase II of the HDF project.The Phase I HDF Metamodel specification and UML Profile will undergo peer review within the Modeling and Methodology committee.MnM will be conducting a peer review of the HDF metamodel during the Q1 and Q2 of Wednesday, October 2, 2002.


HL7 Development Framework Methodology

MDF Methodology HDF Methodology


The MDF Methodology Overview


MDF Models and Process FlowStoryboard


Simplified MDF Data Model


MDF Methodology in a nut shellDomain specialists define the essentials of their messaging requirements. Visio RMIM tooling is available as is a Publications database to document storyboards, interactions and application roles. Specialist prepares a design R-MIM using Rosetree and then builds a preliminary HMD by walking the graphCommittee reviews HMD content. Revise as necessary.Working with spreadsheets of the HMD (or directly using Rosetree), the committee maps out the constraints on the HMD that constitute the specific message typesThe resulting databases are assembled and processed with publication tooling to include in the ballot packageSteps 1-4 are iterative as the Committee clarifies the specifications


The HDF Methodology Overview


text

Title

Double-click to type notes. Subselect "Title"to edit the title.

Project Initiation and Management

Requirements Gathering and Analysis

Requirements Normalization and Harnonization

Specification Design and Packaging

Specification Implementation and Validation

Specification Refinement and Localization

Specification Publication and Balloting

Project Charter

Requirements Specification

ReferenceModel

DesignModel

StandardSpecification

TemplateSpecification

ImplementationProfile

ConformanceSpecification




Project InitiationDefine the project scope and objectivesIdentify project assumptions and constraintsIdentify major project deliverablesIdentify project resource requirementsDevelop project plan with timeline for project phases, activities, and tasksObtain required project approvals


text

Title



Project Charter

Requirements Gathering and AnalysisPrepare storyboards that elaborate upon the project scope statement.Conduct an analysis of the storyboards to identify major Actors and potential Use Cases.Construct a Use Case and Activity model depicting the behavioral component of the requirements. Identify information requirements and construct an information model depicting the static component of the requirements.Prepare Collaboration and Sequence diagrams to depict the interaction requirements.Update the Project Charter as needed.


text

Title




Project Charter

Requirements Normalization and HarmonizationMap models from the Requirements Specification to Reference Models.Revise models in the Requirements Specification based upon discoveries made during the mapping process.Document proposed changes to Reference Models to accommodate unmapped requirements.Follow the reference model harmonization process to adjudicate the proposed changes to Reference Models.Apply approved changes to the HL7 Reference Models.Revise the Requirements Specification as needed and its mapping to the Reference Models.


text

Title




ReferenceModel

Specification Design and PackagingThe Requirements Specification is used to drive the transformation of Reference Models into Design Models.The HDF UML Profile provides constraints to aid in ensuring that design models are well-formed and depict the requirements in a way that remains consistent and traceable back to harmonized reference models.The contents of design models are organized into interdependent packages that partition the design space by domain, sub-domain, and target standard type (message, document, component).Common or reusable design artifacts are packaged in a way that makes them assessable across design model packages and design models.Construction of the design model may lead to new discoveries that result in required enhancements to the reference models.


text

Title




ReferenceModel

DesignModel

Specification Publication and BallotingDesign model content is re-packaged in preparation for publishing.Conflicts and inconsistencies among design models are resolved, including the resolution of artifact identifiers and inter-model references.A publication package is assembled for each ballot specification and a committee level ballot is conducted.Multiple committee level ballots may be required to resolve negative comments received during balloting.A full membership ballot is conducted and upon successful completion the design specification becomes an HL7 standard.At the discretion of the HL7 Board selected HL7 balloted standards are submitted for publication as national or international standards (i.e., ANSI or ISO).


text

Title







Specification Extension and Localization


Project Charter


ReferenceModel

DesignModel






ReferenceModel

DesignModel


Specification Refinement and LocalizationThe balloted HL7 Standard is designed to serve the needs of a large and diverse population of users.It is sometimes necessary to defined additional refinements and constraints to the standard to facilitate its use in a particular context.Context for used of a standard might be influenced by uniqueness in the jurisdiction, region, or clinical discipline for which the standard is to be applied. Because of the international nature of the HL7 standard the need for regional or local refinements is anticipated and the process for localization of the standard is formalized in the HDF.Refinements are applied to the standard specification much in the same way as the iterative refinement that occurred during design.Each refinement may further constrain multiplicities and optionality specified in the standard and may include allowed datatype or vocabulary domain substitutions. The resulting refined/localized standard is a template specification. The template may be registered with HL7 where other in the community defined by the context of the template may access it for use as an extension to the standard specification.Each Template Specification is entirely conformant with the standard specification on which it was based. A Template Specification is a context specific rendering of the standard.


text

Title





Specification Implementation and ValidationImplementation of the standard involves mapping the information component of the standard to data structures in a particular application and incorporating the behavior aspects of the standard into the behavior of the application.The standard specification along with template specifications are used by implementers to develop an implementation profile that describes the design of a particular implementation. The implementation profile includes documentation of the use of extension mechanisms built into the standard, the resolution of choice and optional structures, and a statement of the adherence of the application to sender and receiver responsibilities defined in the standard or template.An Implementation Profile may be used to represent the capabilities of a particular developers application or it may be used to represent the implementation specific requirements of a potential consumer of a vendor product.A conformance specification documents the implementation profile in a format that can be validated against the standard. The conformance specification once validated would highlight those portions of the Implementation Profile that are non-conformant with the HL7 standard specifications.


text

Title







The HDF Methodology Overview


text

Title









Project Charter


ReferenceModel

DesignModel








HDF Methodology Next StepsThe HDF Methodology Specification is still a work-in-progress.The principal drivers behind the design of the HDF methodology are:Maximize the effective use of subject matter experts in shaping the standardExploit the power of the Unified Modeling Language and the Model-Driven ArchitectureEstablish a methodology that is applicable to all the areas in which HL7 intends to establish standardsMaintain a model-driven, technology-neutral, and international perspectiveThe HDF Project will have a phase II in which additional issues will be addressed such as:Consideration of the impact of UML v2.0Consideration of the UN/CEFACT UMM projectConsideration of the OMG MDA activitiesThe MnM Technical Committee will be meeting on Thursday, October 3, 2002 during Q2 and Q3 to begin planning Phase II of the HDF Project.


QuestionsAbdul-Malik ShakirPrincipal Consultant




Thank YouAbdul-Malik ShakirPrincipal Consultant




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

Documents

hl7 modeling

hl7 education

mission of hl7

comprehensive framework

participation of hl7

related standards

project management

evaluation of health

Transcript of HL7 Development Framework Tutorial Abdul-Malik Shakir Principal Consultant, Shakir Consulting...

More Than You Think HL7 is people, HL7 is ideas, HL7 is collaboration.

Assistant Lecturer: Sahar Mohammed Shakir Assistant ...copharm.uobaghdad.edu.iq/uploads/2017/lectuer/Identification of... · Sahar Mohammed Shakir Assistant Lecturer: Sarah Sattar

Climate-Smart Agriculture and Mechanization in Pakistan. PPT_Pakistan.pdf · 3. Mian Irfan Bhatti, Village:Baka Bhattian Khanka Dogran Hafizabad. 4. Malik Shakir Awan, Village: Alipur

bahaa m shakir - 1 File Download

Slide 1 · Web viewGenerate HL7 message (using HL7 v2.4 standard) Hand off HL7 message to HL7 application HL7 Engine (v1.6) Deliver HL7 message to VIE VistA Interface Engine (VIE)

HL7 & HL7 CDA: The - Office of Standard, ETDA · HL7 & HL7 CDA: The Implementation of Thailand’s ... –Derived from HL7 RIM Version 2.07 Source: HL7 CDA R2 . 47 Some Possible Use

Aks-e-Khushboo by Parveen Shakir

SHAKIR SIR CLASSES

HL7 FHIR and the International Patient Summary · HL7 EUROPE09 HL7 European Office Square de Meeûs 38/40 1000 Brussels Belgium E-mail: [email protected] Website: NEWSLETTER HL7 FHIR

HL7 Vocabularies: Bridging Information Models and Vocabulary in HL7 …€¦ · HL7 Vocabularies: Bridging Information Models and Vocabulary in HL7 October 26, 2005 Alexandria, Virginia

S. M. Ali Eslami* Shakir Mohamed* Peter Battaglia* Max ... · S. M. Ali Eslami* [email protected] Shakir Mohamed* [email protected] Peter Battaglia* [email protected] Max

Standards-Compliant SOA to Integrate Knowledge Resources ... · SOA Implementation (SOAP/DSS) HL7 HL7 HL7 HL7 Knowledge request Knowledge Knowledge request Response Knowledge Response

English Quran Shakir W….

TUAN MOHD SHAKIR BIN ABU BAKAR

fccl.com.pkfccl.com.pk/wp-content/uploads/2018/11/Minute-of-26th-AGM-.pdf · Mr Jalal Khan Lt Col Muhammad Irshad Malik (Retd) Brig Abdul Hadi (Retd) Mr Shakir Zamir Siddiqi -do-

Abdul shakir bacm3b_storyboard

Ramathibodi Hospital's Experience with HL7 & HL7 CDA Standards

LinqToSharePoint SandBoxed Solution Shakir Majeed Khan

HL7 NLM Interoperability Survey documents/Standards Activities... · Write an implementation guide for HL7 Version 2 (V2) or HL7 Version 3 (V3) ... HL7-NLM-10: HL7 NLM Interoperability

Shakir khan [000645764)