This wiki has undergone a migration to Confluence found Here

Difference between revisions of "EHRs FM Profiling Tool"

From HL7Wiki
Jump to navigation Jump to search
 
(197 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
[[Category:EHR]]
 
[[Category:EHR]]
==EHR-S FM Profiling Tool Project==
+
==EHR-S FM Profile Designer Tool==
 
'''To return to the >> [[EHR|EHR Work Group Page]]'''
 
'''To return to the >> [[EHR|EHR Work Group Page]]'''
 
<br/>'''To return to the >> [[Tooling Work Group|Tooling Work Group Page]]'''
 
<br/>'''To return to the >> [[Tooling Work Group|Tooling Work Group Page]]'''
===Project Overview===
+
===Introduction===
 +
<br/>The HL7 EHR Work Group developed the EHR-S FM from which Functional Profiles can be derived. For both the management of the Functional Model and the Functional Profiles and the development of Functional Profiles, a tool is developed: the EHR-S FM Profile Designer Tool.
 +
The tool is built as an extension to Enterprise Architect from Sparx. The tool works with the Corporate Edition of Enterprise Architect. when someone wants to develop a Functional Profile from the EHR-S FM with the use of the tool, he needs Enterprise Architect, the extension EHR-S FM Designer Tool, and the computable artifacts to do so.
 +
<br/>The 'Read me' and 'Overview' chapters, as a deliverable of the tooling project, gives an overview of all the artifacts that were developed. Although they are outdated (versions) it still gives an overview:
 +
*[[media:EHR_S_FM_TOOL_C0_ReadmePhase2_v1.2.pdf|Reader’s Guide with a short guided tour of the content of the various chapters of the Profiling Tool documentation]] 
 +
*[[media:EHR_S_FM_TOOL_C1_OverviewPhase2_v1.2.pdf| An overview for the HL7 EHR-S FM Profile Designer Tool.]]
 +
<br/>Sparx has several tutorials of how Enterprise Architect works. For the EHR-S FM Designer Tool several manuals were developed. These manuals and the -How-To-Guide-, this guide describes how to create a Functional Profile, can be found on this wiki.
  
<br/>This project, sponsored by the HL7 Tooling Workgroup and co-sponsored by the EHR Workgroup, produces a desktop tool to create EHR-S FM profiles (starting with the EHR-S FM R2), with enforced profiling rules, and exports as documents, support for and XML interchange format for reuse across profile tool instances or for use in other tools. Additionally, the tool will:
+
<br/>The wiki still contains a lot of project information from the past. This content will be removed in the coming months as the wiki will get a different purpose.
<ul>
 
<li>shall support multiple platforms, Windows, Linux, MacOS, the project starts with Enterprise Architect, which is a windows based tool.</li>
 
<li>be available via OHT.</li>
 
<li>There is a defined XML exchange format that is used by at least one other tool (via import and export of the FM in Enterprise Architect).</li>
 
</ul>
 
<br />This tool will become a tool in the HL7 suite of tools.
 
<br/>
 
This project is targeted for the EHR-S FM R2.  However if it is determined that there is enough harmonization with R1.1, there may be support for references to R1.1 to aid in the updating of manually created R1.1 profiles.
 
  
The project consists of two phases. Phase 1 delivers the design and inclusion of the EHR-S FM into Enterprise Architect. It also includes the validation, and export of the EHR-S FM and documentation.  
+
===Project: a summary===
Phase 2 will consist of creating profiles by using the developed tool in phase 1.
+
This project, sponsored by the HL7 Tooling Workgroup and co-sponsored by the EHR Workgroup, produced a desktop tool to create EHR-S FM Functional Profiles (starting with the EHR-S FM R2), with enforced profiling rules, and exports as documents, support for and XML interchange format for reuse across profile tool instances or for use in other tools. The Project Scope Statement can be found:
 +
[[Media:HL7 Project Scope Statement - EHR-S FM Profiling Tool.doc|HL7 Project Scope Statement - EHR-S FM Profiling Tool.doc]] The project scope statement was approved by the EHR and Tooling Workgroups in November 2011.
 +
The tool is part of the HL7 suite of tools.
  
===Project Need===
+
<br/>Although the project was targeted for the EHR-S FM R2, the goal is to target the PHR-S FM also beginning with the PHR-S FM R2.
The current method of creating EHR-S FM profiles, using unstructured tools (spreadsheet, text processor), do not enforce moderately complex rules for creating EHR-S FM profiles leading to a very laborious manual effort that is prone to errors.  Furthermore the current methods do not easily provide methods for building on top of, merging, or updating existing profiles.  These challenges prove to be significant barriers in the use and adoption of the EHR-S Functional Model.  
+
<br/>The method of creating EHR-S FM Functional Profiles, using unstructured tools (spreadsheet, text processor), did not enforce moderately complex rules for creating EHR-S FM Functional Profiles leading to a very laborious manual effort that is prone to errors.  Furthermore, the methods used in the past did not easily provide methods for building on top of, merging, or updating existing profiles.  These challenges were proved to be significant barriers in the use and adoption of the EHR-S Functional Model.
 +
<br />As said in the Introduction, the EHR-S FM Profile Designer Tool is built as an extension on Enterprise Architect and works with the Corporate Edition. In the same time, a project for MAX was running. Although MAX itself was out of scope the project team decided to use MAX as export format for this work, hence facilitating publishing work group as well. The MAX extension that was built is needed for certain functionality when creating a Functional Profile with the tool. Summarized, someone needs Enterprise Architect, corporate edition, The extension EHR-S FM Profile Designer Tool and the MAX extension.
 +
At this moment (2017-07-03) both extensions and all the computable artifacts are available for HL7 members only and can be obtained by contacting the EHR WG co-chairs (http://www.hl7.org/Special/committees/ehr/leadership.cfm).
 +
<br />More general information on how to create Functional Profiles and the manuals for the tool can be found on this wiki.
  
===Project Success Criteria===
+
===Summary of the status May 2017===
<ul>
 
<li>Supports Functional Models that support the EHR WG specifications (e.g. Personal Health Record System (PHR-S FM) with the same model schema.</li>
 
<li>Tooling is supported by the HL7 tooling workgroup as part of the HL7 suite of tools.</li>
 
<li>Capable of producing fully conformant EHR-S FM profiles, which may be ballotted.</li>
 
<li>Supports exportation of profiles as a document, a computable interchange format (XML), a spreadsheet and a hyperlinked html document.</li>
 
<li>Supports importation of profiles via the defined interchange format.</li>
 
<li>The tool is used in the EHR-S FM Tutorial.</li>
 
 
</ul>
 
  
===Currently Out of Scope===
+
The EHR WG worked on a Errata version of the EHR-S FM, R2.0.1. There are no substansive changes, only typo's and layout issues. A file with all the changes will be published on the HL7 website this summer. A Max.xml file of the Errata version is available to use in the tool.
Other related tooling
 
<br />- Model balloting, balloting, reconciliation, and publishing
 
<br />- MIF
 
<br />- MAX
 
<br />- Desc ???
 
<br />- Links ???
 
  
==Project Leaders==
+
Also a html and csv version is available. Please contact the EHR WG co-chairs to obtain those files.
  
: '''[mailto:Corey.Spears@McKesson.com Corey Spears]'''
+
Phase 3 of the tool development is still in discussion. This phase exists of three parts:
 +
*Support of the tool for translation. the tool can be used for a translation at this moment, but a workaround is needed. Italy did this, so to learn from that experience you need to contact Italy.
 +
*PHR-S FM R2 avilability in Enterprise Architect. In that case Functional Profiles can be made based on the PHR-S FM.
 +
*Support of a framwork like a kind of repository with functions and criteria to choose from.
  
: '''[mailto:johnritter1@verizon.net John Ritter]'''
+
If anyone have ideas on how to realize phase 3, please let the EHR WG co-chairs know.
  
: '''[mailto:m.van.der.zel@umcg.nl Michael van der Zel]'''
 
  
==Project Team==
+
===December 2018: Import PHR-S FM into EHR-S FM Profile Designer Tool===
 +
Project scope:  Allow the Personal Health Record System Functional Model (PHR-S FM) to be managed in the HL7 Enterpries Architect Profile Design Tool.
 +
 +
[https://gforge.hl7.org/gf/project/ehrsfm_profile/docman/Import%20PHR-S%20FM%20into%20EHR-S%20FM%20Profile%20Designer%20Tool/ Project Deliverables on GForge]
  
: '''[mailto:wgoossen@results4care.nl William Goossen, internal projectleader]'''
+
[https://gforge.hl7.org/gf/project/ehrsfm_profile/docman/Import%20PHR-S%20FM%20into%20EHR-S%20FM%20Profile%20Designer%20Tool/Deliverable%205-%20User%20Guide%20for%20HL7%20Profile%20Designer%20Tool/Manual_ProfileDesignerTool_EA_22112018-v9-approved.pdf User Guide - HL7 Profile Designer Tool]
  
: '''[mailto:mvdzel@results4care.nl Michael van der Zel, modeller]'''
+
[https://gforge.hl7.org/gf/project/ehrsfm_profile/docman/Import%20PHR-S%20FM%20into%20EHR-S%20FM%20Profile%20Designer%20Tool/Deliverable%203%20-%20FM%20Import%20Template/FM%20Import%20Template_v01_Deliverable3.xlsx FM Import Template]
  
: '''[mailto:andy.stechishin@gmail.com Andy Stechishin, tester]'''
+
==How to create a Functional Profile==
 +
===How-To Guide===
 +
The [[Media:How-to_Guide_R2_final.pdf|How-to Guide]] offers guidance for using the EHR-S FM Profiling Designer tool to create functional profiles that conforms to the HL7 EHR-S Functional Model (denoted hereafter FM). A conforming functional profile is one that adheres to the rules specified in the FM Conformance Clause, (Section 6). Please note that the ‘How-to guide’ is not a replacement for the Conformance Clause. You are encouraged to read Section 6 carefully.  For the remainder of this section, the term profile will be used as shorthand for functional profile.
 +
<br/>The guide offers guidelines — not binding directives. It will walk you through the basic steps involved in creating a conforming functional profile, including the development of a conformance clause and conformance criteria. The How-to Guide offers a few general principles to keep in mind as you create the functional profile. Also, it provides guidance on how and why you should consider balloting the profile you created. It assumes that you are familiar with the FM and are knowledgeable about the requirements associated with a particular EHR-S healthcare delivery setting.
  
: '''[mailto:agoossen@results4care.nl Anneke Goossen, documenter]'''
+
The December 2018 version of the [[Media:Profile_Designer_Tool_User_Guide_for_EA_20181122-8.pdf|Profile Designer Tool User Guide for EA]] is an update that contains instructions for using the Profile Designer Tool on the Personal Health Record System Functional Model.
  
==Meeting Information==
+
===Manuals===
'''Conference Calls'''<br>
+
The EHR-S FM R2 standard is published as a pdf on the HL7 website and is available for everyone. The EHR-S FM is also published in html, csv, max.xml and as an eap. file, this is the file Enterprise Architect can use. As said before, these files are only available for HL7 members at this moment. How to install the extension is described in [[media:EHR_S_FM_FP_Designer_TOOL_Installing_the_extension_v04.pdf|'Installing the extension']].
The project team has a weekly conference call on Monday evening.
 
  
Members of the project team will join the regular conference calls of the WG EHR and the WG Tooling.
+
How to create a Functional Profile with the tool and the use of the max.xml file is described in several manuals. The manuals follow the logical steps you have to take when creating a Functional Profile.
  
==Project Documents==
+
NOTE: the extension is not tested yet with the latest version of Enterprise Architect due to current work on several functional profiles. The manuals have screenshots in it from older versions of enterprise Architect.
[[Media:HL7 Project Scope Statement - EHR-S FM Profiling Tool.doc|HL7 Project Scope Statement - EHR-S FM Profiling Tool.doc]]
 
*The project scope statement was approved by the EHR and Tooling Workgroups in November 2011.
 
  
==Project Status==
+
===Browse and search===
===Project Plan Draft===
+
To browse and search in the EHR-S FM R2 you need the eap. file of the FM that Enterprise Architect, EA, can read. With EA you can open the EHR-S FM, you can browse through the FM and read all the components of the FM. You can do this even if you are not creating a Functional Profile with the tool. The manuals created for this functionalities are [[media:ReadtheEHRSFM.pdf|'Read the EHR-S FM']] and [[Media:SearchEHRSFM.pdf|'Search the EHR-S FM']].
This project is slated to follow an iterative development pattern. Below is an initial draft for the first iteration.
 
<ol>
 
<li>Functional requirement definition
 
<ul>
 
<li>EHR-S FM Chapter 2 (Conformance rules - Tool business rules)</li>
 
<li>Define user experience requirements</li>
 
<li>Functional Brainstorm and Survey (define initial release functional requirements</li>
 
</ul>
 
</li>
 
<li>Existing tool analysis</li>
 
<li>Functional Specification</li>
 
<li>Technical Specification</li>
 
<li>Development</li>
 
<li>Testing</li>
 
<li>Release</li>
 
</ol>
 
<br />
 
  
===Dependencies===
+
<br/>Another functionality that can be used is looking at the traceability of elements in the EHR-S FM. In the EHR-S FM there are different relationships between the elements. The Traceability window in EA enables you to quickly see how elements, headers, functions and criteria in the functional model or functional profile, are connected and how they influence each other. How to use this functionality is described in [[Media:TraceabilityElements.pdf|'Traceability of the elements in EHR-S FM']]
<br/>The project depends on the availability of the following materials:
 
<ul>
 
<li>Full XML export from the EHR-S FM spreadsheet</li>
 
This material has been made available Dec 31, 2012.
 
<li>Validation rules for the EHR-S FM</li>
 
The validation rules where provided in September 2012 and used as input to the validation function.
 
</ul>
 
  
===Current Activities in Tool Creation Phase 1===
+
===Create a Functional Profile===
[[ File:Explanation1-7stepsEHR-S-FM.png |1040px|thumb|none| Different steps in tool creation phase 1 ]]
+
A new Functional Profile is based on a Base Model. This can be the EHR-S FM (started with Release 2.0) or an existing Functional Profile (based on the EHR-S FM R 2.0). From the Base Model a Profile Definition is defined. After defining the Profile Definition the new Functional Profile can be compiled. In an [[media:0Introduction.pdf|Introduction chapter]], the design of the EHR-S FM Profile Designer Tool is described
The figure shows the numbers that will generate the various materials to create the tool.
 
<br/>1. Exporting XML from the EHR-S FM spreadsheet.
 
<br/>2. EHR-S FM design pattern development.
 
<br/>2. EHR-S FM XML to UML mapping.
 
<br/>3. Inclusion of the EHR-S FM in Enterprise Architect.
 
<br/>4. Completing the set of validation rules for EHR-S FM.
 
<br/>5. Generate validation report to tool user.
 
<br/>6. Documentation to export EHR-S FM from Enterprise Architect (publication templates).
 
<br/>7. Exporting EHR-S FM documentation from Enterprise Architect (ballot artefacts).
 
In addition there will be a user guide containing:  
 
<br/>User documentation for EHR-S FM import/installation in Enterprise Architect.
 
<br/>Documentation to use EHR-S FM in Enterprise Architect.
 
  
===What has been done till end of September 2012===
+
<br/>In the manuals 1 to 9 the creation of a Functional Model based on the EHR-S FM is described.
<br/>The project team has held weekly Skype conference calls to discuss the goals, plan, deliverables, work and progress.
+
<br/>1. Create a new project for a new Functional Profile
<br/>A Github repository for the source code was established for the project team, which at the end of the project will be handed over to HL7
+
*The first step in the creation of a new Functional profile is the creation of a new project in Enterprise Architect, EA,[[media:1CreateNewProfile.pdf|'Create a Functional Profile']]
<br/>A MS Groove folder was established for all other files, meeting agenda’s and reports, links etc, for internal use.
+
<br/>2. Load a Base Model for creation of a new Functional profile
<br/>The HL7 Sept 2012 WGM was prepared for, through a PowerPoint presentation, delivered to Tooling WG, EHR WG and tooling planning meeting.
+
*The first rule for Functional Profiles is the identification of the Functional Model or Functional Profile from which you want to derive the new Functional Profile. This is the called ‘Base Model’. To do so you have to select the FM or FP for that and load the FM or FP into Enterprise Architect as described in  [[media:2LoadBaseModel.pdf|Load the Base Model']]. To do so you will need the MAX file of that FM or FP. Be sure that you use the latest version of the MAX file! Ask the EHR WG co-chairs for the file.
<br/>Dependency was discussed, and consequences expressed. In case that would become a blockade, report to HL7 before December 1.
+
<br/>3. Create package for (compiled) Functional Profile
<br/>The EHR workgroup members have been asked for validation rules. These where provided, and discussed in the conference call Sept 25. A draft document with validation rules was created.
+
*The third step is the [[media:3CreatePackageforFP.pdf|creation of a package]] (EA Term) for the new Functional Profile. In the 'Introduction' chapter, this is represented in figure 2 and 3.
<br/>Initial efforts to create the wiki page for the project have been undertaken and we will follow up with the EHR WG how to arrange that.
+
<br/>4. Provide General Information
<br/>XML to UML import meta model was available for R1.1. This existing material is changed to EHR-S FM R2. Our current version of the UML meta model of R2 is v 3.2. This will definitely change when the import, meta model and UML representation and mapping are 100%.
+
*A basic requirement of all functional profiles is to unique identify and to convey [[media:4ProvideGeneralInformation.pdf|general information]] about the Functional Profile. This needs to be done in EA otherwise, you cannot make a Profile Definition. However, the general information on the functional Profile is usually described in an Overview chapter that is published together with the Functional Profile itself.
 +
<br/>5. Create UML model for the new Functional Profile
 +
*For the Profile Definition, you need to create an [[media:5CreateUMLmodelNewFP.pdf|UML model]] in where is shown how the Profile Definition, the Base Model and the actual new Functional Profile relates to each other. This needs to be done so everything you define form the Base Model is included in the Profile Definition. And of course, everything that is defined in the Profile Definition is included in the actual new Functional Profile. Figure 3 in the 'Introduction' shows you how this UML model looks like.
 +
<br/>6. Create the Functional Profile definition
 +
*The base for the new Functional Profile is the Base Model, FM or FP. The [[media:6CreateProfileDefinition.pdf|Profile Definition]] for the new Functional Profile is based on that Base Model. In this manual is also described how to lock the Base Model to prevent you for making changes in the Base Model instead of the Profile Definition.
 +
<br/>7. Create the Compiled Profile
 +
*The base for the new Functional Profile is the Profile Definition. From there a [[media:7CreateCompiledProfile.pdf|compiled profile is created]].
 +
<br/>8. Validation of Profile Definition and Compiled Profile
 +
*All the rules for Functional Profile creation were included in the EHR-S FM FP Designer tool as validation rules. Running a [[media:8Validation.pdf|validation]] will give you a report on errors and warnings on the work you have done on the Profile Definition or the Compiled Profile.
 +
<br/>9. Running Functional Model and Functional Profile Publication
 +
*Once the Functional Profile has been created, you will want to publish the specification for others to use. For the creation of the publication, you need the Model Automated eXchange (MAX) file of the Compiled Profile. This MAX file is an output of the Enterprise Architect (EA) EHR-S FM FP Designer Tool. In this manual [[media:9CreatePublication.pdf|'Create a publication']] guidance is given on how to create the publication from the MAX file. In the process of creating the publication, different software is used. Which software and where to find it is described in the manual .
  
===Deliverables of End of September 2012===
 
<br/> Report 1.
 
<br/>The May 2012 XML file, as then was generated by Mr. Corey Spears has been included in this package. That is not so much a delivery, but an important baseline file for the current project. All additional material provided here is derived from that file.  (# 1 in figure 1). < File EHRS_FM_R2_N1_C3_FunctionList_2012MAY.XML />
 
<br/>The current Sept version of the UML representation of the EHR-S FM as derived from the May 2012 XML version. This is available as an 90 to 95% ready Enterprise Architect Project EAP, and as an XMI file (XML Metadata Interchange, where XML stands for eXtended Markup Language). (# 3 in figure 1). < File: EHR-S_FM_R2IntermediateVersionSept29-2012/>
 
<br/>Tool design sheet. This describes the whole process (see figure 1 on the bottom of this report). This includes the UML metamodel (# 2 in figure 1). < File: Design Sheets from EA (2012-sep-26)/>
 
  
===What has additionally been done till end of November 2012===
+
===Edit the Functional Profile===
<br/> Weekly Skype conference calls
+
The Functional Profile inherits functions and criteria from its Base Model and serves a certain purpose, e.g Domain. For this purpose the functions and criteria can be changed in a more precise description or examples applicable for that purpose can be added. Also, there can be a need for adding criteria in existing functions or even adding functions in the Functional Profile. The functionalities for this are described in the following manuals.  
<br/> Consultations of EHR WG members to obtain the Excel and XML source files of the EHR-S FM.
 
<br/> This wiki page for the project updated
 
<br/> Validation rules obtained from WG and put into a first draft document, for which input was asked in conference calls.  
 
<br/> Checks against the XML to UML import meta-model for EHR-S FM R2 draft (v 3.2).
 
<br/> May 2012 XML from ballot was used as baseline file for the draft work. 
 
<br/> 90% ready UML representation of the EHR-S FM delivered.
 
<br/> Excel to XML exports developed
 
<br/> Decisions made to include the informative parts of the EHR-S FM as add on’s to the XML.
 
<br/> Preliminary work done for future export of the EHR-S FM from UML using MAX.
 
<br/> Initial testing approach discussed.
 
<br/> Export XML from Excel tool developed.
 
<br/> Import of EHR-S FM from new XML into EA now 97% ready.
 
<br/> Preview EHR-S FM Export in MAX developed.
 
<br/> First draft of user guide developed.
 
  
===Deliverables of End November 2012===
+
<br/>Adding EHR-S FM components
<br/> Report 3.  
+
*This manual describes the way new components, sections, headers, functions and/ or conformance criteria can be added to a Functional Profile with the support of the EHR-S FM Profile Designer Tool, [[media:AddingEHR_S_FMFPcomponents.pdf|manual]].  
<br/> XML-GeneratorEHR-S FM R2 Zap. This file must be renamed to *.zip to open. It contains the Ruby tool to extract full EHR-S FM contents from Excel into XML. See the instruction in the user guide to install and apply.  
+
<br/>Working in a project on a new functional profile
<br/> EA file with the EHR-S FM fully included: EHR-S FM R2-XMLimport2.2Only.zap, to be renamed *.zip to allow extraction.  
+
*The development of a new Functional Profile is usually done in a multidisciplinary project team. Depending on the part of the Base Model, domain expert, IT experts, security experts etc, are part of the project team. Collaboration of the project team can be done with or without using Enterprise Architect HL7 EHR-S FM Extension. Several option are described in the [[media:CollaborationFunctionalProfile.pdf|manual]].
<br/> First preview of EHR-S FM export from EA: EHRS_FM_R2 (import v2.2) generated-ehrs-fm-20121115-full2.max
+
<br/>Moving EHR-S FM Components
<br/> User Guide tool-v05.doc with the first draft for comment user guide, covering the part that has been prepared.
+
*This document describes the way components, sections, headers, functions and/ or conformance criteria, of the EHR-S FM can be moved, [[media:MovingEHR_S_FMFPcomponents.pdf|manual]].
 +
<br/>Project Management
 +
*The development of a new Functional Profile is usually done in a project in where several parties are involved. Support for the [[media:ProjectManagement.pdf|project management]] can be done with several tools. As a project facilitator, you can contribute to project management by using Enterprise Architect, EA. In this context, it is important to determine what of the project management is done by the project leader, in another tool then EA, and what by the project facilitator, done in EA.
 +
<br/>Tracking Changes
 +
*During the development of the tool people with the experience of creating a new Functional Profile asked for the requirement of the possibility to [[media:TrackingChanges.pdf|track changes]] in the Profile Definition. See for a detailed description of how to create a [[media:6CreateProfileDefinition.pdf|'Create Profile Definition]].
  
===What has been done till end of January 2013===
 
#Continued weekly Skype conference calls, with some interruptions for holiday and Jan WGM.
 
#A Github repository for the source code and all deliverables are made available for EHR WG.http://gforge.hl7.org/gf/project/ehrsfm_profile/frs/
 
#MS Groove folder for internal use and meetings.
 
#PowerPoint presentations at HL7 Sept 2012 and January 2013 WGMs.
 
#Dependency discussed at WGM and in conference and individual calls.
 
#Mr. Corey Spears consulted in Dec 2012 and Jan 2013 with results in XML/ schema suggestions.
 
#EHR workgroup provided validation rules and reviewed the validation rules document.
 
#XML to UML import meta-model for EHR-S FM R2 draft was created (v 3.2).
 
#May 2012 XML was used as baseline file for the draft work.
 
#Corey Spears’ XML materials and Helen Stevens’ master Excel table where used to check and update the approach.
 
#90% ready UML representation of the EHR-S FM delivered, waiting for update to 100% once validation is approved.
 
#Tool design sheet delivered, describing the whole process (see figure 1 on the bottom of this report).
 
#Excel to XML exports developed and delivered.
 
#Decisions made to include the informative parts of the EHR-S FM as add on’s to the XML.
 
#Export from EA EHR-S FM in UML to XML using MAX format confirmed, using xpath 1.
 
#Initial testing approach discussed and first draft test approach developed and delivered Jan 2013.
 
#Additional export XML from Excel tool developed and reviewed.
 
#Import of EHR-S FM from new XML into EA now 99% ready.
 
#User guide discussed with EHR WG, will be updated when new materials are approved.
 
#Errors in XML document has been discussed and solutions for most issues determined.
 
#Internal Testing the XML generation from XLS.
 
#Internal Testing Import of the full XML into EAP, using the XML R2 Schema.
 
#Organize feedback from WGs to UML representation of the EHR-S FM based on full XML export from Excel.
 
#Discuss the validation rules with WG and create first validator as stand alone version.
 
  
===Summary of the January 2013 deliverables===
+
===Export during the development process===
#EHRSFM_EA_AddIn (2013-jan-27) v2.zap (http://gforge.hl7.org/gf/project/ehrsfm_profile/frs/). This file must be renamed to *.zip to open. It contains the EHR-S FM extension to EA tool.
+
For the development of a Functional Profile, several stakeholders are involved in reviewing the EHR-S FM or an existing Functional Profile. The review can take place in several ways 1) with the tool and 2) with an export in RTF (Rich Text Format document). In the [[media:ExportSection.pdf|manual 'Export Section']] is described how to create an export for the use of a review.
#FM-validation file.It contains the EHR-S FM validation tool in a version external to EA for stand alone testing.
 
#Unchanged EHR-S FM export from EA: EHRS_FM_R2 (import v2.2) generated-ehrs-fm-20121115-full2.max (http://gforge.hl7.org/gf/project/ehrsfm_profile/frs/).
 
#Edit Forms in EA (2013-jan-27) which illustrates first drafts of the user interface for EHR S #FM (colored sections) and the validator output (black / white on left bottom). See figure below.
 
#EHR-S-FM-Testdesign. First draft for comment of the test of the tool by the EHR and tooling WG. the final document will be published.
 
#We have uploaded the release package to the GForge EHR-S FM Tool project here: http://gforge.hl7.org/gf/project/ehrsfm_profile/frs/?action=index. This release is labeled 2013-Jan.
 
  
This release contains an update for the Enterprise Architect plug-in, a Schematron file to validate Functional Model extracts in MAX format, a stand-alone version of the Schematron file (an XSLT 1.0 file that will run with any XSLT 1.0 processor such as xsltproc on the command line), a sample MAX format file that contains an export of the preliminary load of the EHR-S FM into EA, a MAX format file that contains intentional error used in testing the Schematron validations, the validations document from the EHR WG with additional notes to trace the validation errors (by ID) to the source (not complete), the detail design spreadsheet containing the full list of validations identified to date with progress/status (and where applicable questions or comments on the validation), and a PDF with a sample of color-coding the input forms for the functional models in EA.
+
For the export, you need a template that can be used in Enterprise Architect. This template comes with the computable artifacts needed when you want to use the tool for the creation of a functional profile. Please contact the EHR WG co-chairs.
  
Please note that the Schematron validations and the detail validation design are preliminary deliverables, not final. We are expecting that these will continue to evolve in the next release cycle prior to final acceptance.
+
How to import the template in EA is described in the manual.
  
During EHR WG Conference cals the organization of the test will be discussed.
+
===Frequently asked questions, FAQ===
 
+
During the development of the tool, questions were asked about how the tool supports certain functionalities or how to deal with certain issues where users ran into. From these questions, we created a document with [[media:FAQ.pdf|FAQ]]. In the answer, we point to the chapter in the Learning Center in where a more detail description is given.
[[File:Edit_Forms_in_EA_(2013-jan-27)1.png |800px|thumb|none|  Sample of how sections, functions and criteria will look like in the EHR-S FM tool]]
 
 
 
===Past Activities===
 
<br/>Creation of an EHR Tooling list - Helen
 
<br/>Suggestions mechanism - Michael
 
<br/>Invite Profiling SMEs - John
 
<br/>EHR-S FM Chapter 2 -> Link ???
 
 
 
===Current Functional List===
 
The following list contains all thus far identified functionality in general order of priority (greatest to least)
 
 
 
===Input ''(not specific to this project, but defined through from EHR-S FM development and publication)''===
 
*EHR-S FM R2 source in XML
 
 
 
 
 
===Absolute Functionality ''(Top Priority)''===
 
# Enforce profiling rules (per Conformance Chapter)
 
## Include/Exclude functions from profile
 
## Conformance Optionality
 
## Conditional Criteria
 
## Criteria Inheritance
 
## Add functions and criteria
 
## Modify functions and criteria
 
##... ''(Other absolute profile rules)''
 
# output formats
 
## HTML
 
## PDF
 
## XML
 
# Browse & Navigation of the funtional model
 
## search capabilities, filtering capabilities, keyword search, search & replace.
 
# Tool is framework specific (e.g. coded to EHR WG FM framework specifications), but content in-specific (enables the import/export of different conformant models/versions (e.g. EHR-S FM 2, future PHR-S FM). (Tool is content agnostic)
 
# Save profile
 
 
 
 
 
===Needed Functionality ''(High priority)''===
 
# Ability to revert to previous state (undo)
 
# Simple text copy paste (text editor related)
 
# Text formatting (highlight, bold, underline, font, italicize
 
# Show dependencies between functions/criteria
 
## Show impact of changes
 
# Undo changes
 
# Capture comments regarding specific elements (i.e. comments regarding specific functions or criteria)
 
# Initialize/revert to conformant base standard (clear old comments, reset to clean restart to new version activity)
 
# Ability to link functional model/profile (intra/inter base standard and profile, linked to a conceptual model, bi-directionally)
 
 
 
 
 
===Operative Functionality ''(Medium Priority)''===
 
# Output format HL7 HTML publication format (i.e. to publish through HL7 Publishing)
 
## Generate publication ready documents.
 
# Attach front-matter to publication. Chapter 1 (Additional material
 
# Maintain original for comparison with modified function/criteria
 
# Compare to other profiles
 
# Merge Functions/Criteria from separate Profiles
 
# Export Sections from Master or working copy
 
# Function copy paste 
 
# Balloting & reconciliation traceability version control
 
## Managing voting and input from reviewers.
 
## Reporting out all comments against an element.  
 
# Capturing institutional memory "allow for comments/notes" attached to elements.
 
# converting a profile from one version to the next.
 
## If you have a profile based on R2.0, have the tool update baseline profile to R2.1 as starting point.
 
# Requirements regarding tooling access (online)
 
## Support multi user - multiple users working on same profile at same time?
 
## User Management, access control
 
# Workflow management tool (assigning activities to users)
 
 
 
 
 
===Additional Functionality ''(Low Priority)''===
 
# mobile access
 
 
 
* Note - will not support R1.1.  Is it necessary to convert R1/R1.1 to R2?
 
 
 
====[[EHR-S FM Profiling Tool: Working Documents|Additional Working Documents]]====
 
  
 
==Listserv==
 
==Listserv==
The EHR-S FM Profiling Tool Project is currently being set up.
+
The EHR-S FM Profiling Tool is part of the activities of the EHR WG. To follow the developments of Functional Models, Functional Profiles and on the tool please subscribe to the EHR WG mailing list.
 
<br />To subscribe to a list service, please go to the [http://www.hl7.org/listservice/index.cfm HL7 Listservices Welcome Page]
 
<br />To subscribe to a list service, please go to the [http://www.hl7.org/listservice/index.cfm HL7 Listservices Welcome Page]
 
==Additional Work==
 
Make the FM available in UML for incorporation in UML Modeling & Design. Used with the EHR FIM, see [[EHR Interoperability WG]].
 
The mapping is for R2 now as work in progress for the EHR-S FM tool part phase 1. See first picture below. An earlier version for R1.1. has informed the work for R2. See 2nd picture below.
 
 
[[File:Design_Sheets_from_EA_%282012-oct-12%29-v2_Page_3.png |800px|thumb|none| R2 Meta model in UML work in progress]]
 
 
 
 
 
 
 
 
[[File:EHR-S_FM_UML_meta-model_v3.1_(2011-nov-04).png|800px|thumb|none|R1.1 UML meta model]]
 

Latest revision as of 15:18, 23 January 2019

EHR-S FM Profile Designer Tool

To return to the >> EHR Work Group Page
To return to the >> Tooling Work Group Page

Introduction


The HL7 EHR Work Group developed the EHR-S FM from which Functional Profiles can be derived. For both the management of the Functional Model and the Functional Profiles and the development of Functional Profiles, a tool is developed: the EHR-S FM Profile Designer Tool. The tool is built as an extension to Enterprise Architect from Sparx. The tool works with the Corporate Edition of Enterprise Architect. when someone wants to develop a Functional Profile from the EHR-S FM with the use of the tool, he needs Enterprise Architect, the extension EHR-S FM Designer Tool, and the computable artifacts to do so.
The 'Read me' and 'Overview' chapters, as a deliverable of the tooling project, gives an overview of all the artifacts that were developed. Although they are outdated (versions) it still gives an overview:


Sparx has several tutorials of how Enterprise Architect works. For the EHR-S FM Designer Tool several manuals were developed. These manuals and the -How-To-Guide-, this guide describes how to create a Functional Profile, can be found on this wiki.


The wiki still contains a lot of project information from the past. This content will be removed in the coming months as the wiki will get a different purpose.

Project: a summary

This project, sponsored by the HL7 Tooling Workgroup and co-sponsored by the EHR Workgroup, produced a desktop tool to create EHR-S FM Functional Profiles (starting with the EHR-S FM R2), with enforced profiling rules, and exports as documents, support for and XML interchange format for reuse across profile tool instances or for use in other tools. The Project Scope Statement can be found: HL7 Project Scope Statement - EHR-S FM Profiling Tool.doc The project scope statement was approved by the EHR and Tooling Workgroups in November 2011. The tool is part of the HL7 suite of tools.


Although the project was targeted for the EHR-S FM R2, the goal is to target the PHR-S FM also beginning with the PHR-S FM R2.
The method of creating EHR-S FM Functional Profiles, using unstructured tools (spreadsheet, text processor), did not enforce moderately complex rules for creating EHR-S FM Functional Profiles leading to a very laborious manual effort that is prone to errors. Furthermore, the methods used in the past did not easily provide methods for building on top of, merging, or updating existing profiles. These challenges were proved to be significant barriers in the use and adoption of the EHR-S Functional Model.
As said in the Introduction, the EHR-S FM Profile Designer Tool is built as an extension on Enterprise Architect and works with the Corporate Edition. In the same time, a project for MAX was running. Although MAX itself was out of scope the project team decided to use MAX as export format for this work, hence facilitating publishing work group as well. The MAX extension that was built is needed for certain functionality when creating a Functional Profile with the tool. Summarized, someone needs Enterprise Architect, corporate edition, The extension EHR-S FM Profile Designer Tool and the MAX extension. At this moment (2017-07-03) both extensions and all the computable artifacts are available for HL7 members only and can be obtained by contacting the EHR WG co-chairs (http://www.hl7.org/Special/committees/ehr/leadership.cfm).
More general information on how to create Functional Profiles and the manuals for the tool can be found on this wiki.

Summary of the status May 2017

The EHR WG worked on a Errata version of the EHR-S FM, R2.0.1. There are no substansive changes, only typo's and layout issues. A file with all the changes will be published on the HL7 website this summer. A Max.xml file of the Errata version is available to use in the tool.

Also a html and csv version is available. Please contact the EHR WG co-chairs to obtain those files.

Phase 3 of the tool development is still in discussion. This phase exists of three parts:

  • Support of the tool for translation. the tool can be used for a translation at this moment, but a workaround is needed. Italy did this, so to learn from that experience you need to contact Italy.
  • PHR-S FM R2 avilability in Enterprise Architect. In that case Functional Profiles can be made based on the PHR-S FM.
  • Support of a framwork like a kind of repository with functions and criteria to choose from.

If anyone have ideas on how to realize phase 3, please let the EHR WG co-chairs know.


December 2018: Import PHR-S FM into EHR-S FM Profile Designer Tool

Project scope: Allow the Personal Health Record System Functional Model (PHR-S FM) to be managed in the HL7 Enterpries Architect Profile Design Tool.

Project Deliverables on GForge

User Guide - HL7 Profile Designer Tool

FM Import Template

How to create a Functional Profile

How-To Guide

The How-to Guide offers guidance for using the EHR-S FM Profiling Designer tool to create functional profiles that conforms to the HL7 EHR-S Functional Model (denoted hereafter FM). A conforming functional profile is one that adheres to the rules specified in the FM Conformance Clause, (Section 6). Please note that the ‘How-to guide’ is not a replacement for the Conformance Clause. You are encouraged to read Section 6 carefully. For the remainder of this section, the term profile will be used as shorthand for functional profile.
The guide offers guidelines — not binding directives. It will walk you through the basic steps involved in creating a conforming functional profile, including the development of a conformance clause and conformance criteria. The How-to Guide offers a few general principles to keep in mind as you create the functional profile. Also, it provides guidance on how and why you should consider balloting the profile you created. It assumes that you are familiar with the FM and are knowledgeable about the requirements associated with a particular EHR-S healthcare delivery setting.

The December 2018 version of the Profile Designer Tool User Guide for EA is an update that contains instructions for using the Profile Designer Tool on the Personal Health Record System Functional Model.

Manuals

The EHR-S FM R2 standard is published as a pdf on the HL7 website and is available for everyone. The EHR-S FM is also published in html, csv, max.xml and as an eap. file, this is the file Enterprise Architect can use. As said before, these files are only available for HL7 members at this moment. How to install the extension is described in 'Installing the extension'.

How to create a Functional Profile with the tool and the use of the max.xml file is described in several manuals. The manuals follow the logical steps you have to take when creating a Functional Profile.

NOTE: the extension is not tested yet with the latest version of Enterprise Architect due to current work on several functional profiles. The manuals have screenshots in it from older versions of enterprise Architect.

Browse and search

To browse and search in the EHR-S FM R2 you need the eap. file of the FM that Enterprise Architect, EA, can read. With EA you can open the EHR-S FM, you can browse through the FM and read all the components of the FM. You can do this even if you are not creating a Functional Profile with the tool. The manuals created for this functionalities are 'Read the EHR-S FM' and 'Search the EHR-S FM'.


Another functionality that can be used is looking at the traceability of elements in the EHR-S FM. In the EHR-S FM there are different relationships between the elements. The Traceability window in EA enables you to quickly see how elements, headers, functions and criteria in the functional model or functional profile, are connected and how they influence each other. How to use this functionality is described in 'Traceability of the elements in EHR-S FM'

Create a Functional Profile

A new Functional Profile is based on a Base Model. This can be the EHR-S FM (started with Release 2.0) or an existing Functional Profile (based on the EHR-S FM R 2.0). From the Base Model a Profile Definition is defined. After defining the Profile Definition the new Functional Profile can be compiled. In an Introduction chapter, the design of the EHR-S FM Profile Designer Tool is described


In the manuals 1 to 9 the creation of a Functional Model based on the EHR-S FM is described.
1. Create a new project for a new Functional Profile

  • The first step in the creation of a new Functional profile is the creation of a new project in Enterprise Architect, EA,'Create a Functional Profile'


2. Load a Base Model for creation of a new Functional profile

  • The first rule for Functional Profiles is the identification of the Functional Model or Functional Profile from which you want to derive the new Functional Profile. This is the called ‘Base Model’. To do so you have to select the FM or FP for that and load the FM or FP into Enterprise Architect as described in Load the Base Model'. To do so you will need the MAX file of that FM or FP. Be sure that you use the latest version of the MAX file! Ask the EHR WG co-chairs for the file.


3. Create package for (compiled) Functional Profile

  • The third step is the creation of a package (EA Term) for the new Functional Profile. In the 'Introduction' chapter, this is represented in figure 2 and 3.


4. Provide General Information

  • A basic requirement of all functional profiles is to unique identify and to convey general information about the Functional Profile. This needs to be done in EA otherwise, you cannot make a Profile Definition. However, the general information on the functional Profile is usually described in an Overview chapter that is published together with the Functional Profile itself.


5. Create UML model for the new Functional Profile

  • For the Profile Definition, you need to create an UML model in where is shown how the Profile Definition, the Base Model and the actual new Functional Profile relates to each other. This needs to be done so everything you define form the Base Model is included in the Profile Definition. And of course, everything that is defined in the Profile Definition is included in the actual new Functional Profile. Figure 3 in the 'Introduction' shows you how this UML model looks like.


6. Create the Functional Profile definition

  • The base for the new Functional Profile is the Base Model, FM or FP. The Profile Definition for the new Functional Profile is based on that Base Model. In this manual is also described how to lock the Base Model to prevent you for making changes in the Base Model instead of the Profile Definition.


7. Create the Compiled Profile


8. Validation of Profile Definition and Compiled Profile

  • All the rules for Functional Profile creation were included in the EHR-S FM FP Designer tool as validation rules. Running a validation will give you a report on errors and warnings on the work you have done on the Profile Definition or the Compiled Profile.


9. Running Functional Model and Functional Profile Publication

  • Once the Functional Profile has been created, you will want to publish the specification for others to use. For the creation of the publication, you need the Model Automated eXchange (MAX) file of the Compiled Profile. This MAX file is an output of the Enterprise Architect (EA) EHR-S FM FP Designer Tool. In this manual 'Create a publication' guidance is given on how to create the publication from the MAX file. In the process of creating the publication, different software is used. Which software and where to find it is described in the manual .


Edit the Functional Profile

The Functional Profile inherits functions and criteria from its Base Model and serves a certain purpose, e.g Domain. For this purpose the functions and criteria can be changed in a more precise description or examples applicable for that purpose can be added. Also, there can be a need for adding criteria in existing functions or even adding functions in the Functional Profile. The functionalities for this are described in the following manuals.


Adding EHR-S FM components

  • This manual describes the way new components, sections, headers, functions and/ or conformance criteria can be added to a Functional Profile with the support of the EHR-S FM Profile Designer Tool, manual.


Working in a project on a new functional profile

  • The development of a new Functional Profile is usually done in a multidisciplinary project team. Depending on the part of the Base Model, domain expert, IT experts, security experts etc, are part of the project team. Collaboration of the project team can be done with or without using Enterprise Architect HL7 EHR-S FM Extension. Several option are described in the manual.


Moving EHR-S FM Components

  • This document describes the way components, sections, headers, functions and/ or conformance criteria, of the EHR-S FM can be moved, manual.


Project Management

  • The development of a new Functional Profile is usually done in a project in where several parties are involved. Support for the project management can be done with several tools. As a project facilitator, you can contribute to project management by using Enterprise Architect, EA. In this context, it is important to determine what of the project management is done by the project leader, in another tool then EA, and what by the project facilitator, done in EA.


Tracking Changes

  • During the development of the tool people with the experience of creating a new Functional Profile asked for the requirement of the possibility to track changes in the Profile Definition. See for a detailed description of how to create a 'Create Profile Definition.


Export during the development process

For the development of a Functional Profile, several stakeholders are involved in reviewing the EHR-S FM or an existing Functional Profile. The review can take place in several ways 1) with the tool and 2) with an export in RTF (Rich Text Format document). In the manual 'Export Section' is described how to create an export for the use of a review.

For the export, you need a template that can be used in Enterprise Architect. This template comes with the computable artifacts needed when you want to use the tool for the creation of a functional profile. Please contact the EHR WG co-chairs.

How to import the template in EA is described in the manual.

Frequently asked questions, FAQ

During the development of the tool, questions were asked about how the tool supports certain functionalities or how to deal with certain issues where users ran into. From these questions, we created a document with FAQ. In the answer, we point to the chapter in the Learning Center in where a more detail description is given.

Listserv

The EHR-S FM Profiling Tool is part of the activities of the EHR WG. To follow the developments of Functional Models, Functional Profiles and on the tool please subscribe to the EHR WG mailing list.
To subscribe to a list service, please go to the HL7 Listservices Welcome Page