This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "EHRs FM Profiling Tool"

From HL7Wiki
Jump to navigation Jump to search
 
(63 intermediate revisions by 3 users not shown)
Line 6: Line 6:
 
<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.
 
<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.  
 
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 chapter, as a deliverable of the tooling project gives an overview of all the artefacts that were developed. Although it is outdated (versions) it still gives an overview [[EHR_S_FM_TOOL_C0_ReadmePhase2_v1.1.pdf]]
+
<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/>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/>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.
 
<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.
  
−
===Project a summary===
+
===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:
 
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.
 
[[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.
Line 22: Line 24:
 
<br />More general information on how to create Functional Profiles and the manuals for the tool can be found on this wiki.
 
<br />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 March 2017===
+
===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.
 +
 +
[https://gforge.hl7.org/gf/project/ehrsfm_profile/docman/Import%20PHR-S%20FM%20into%20EHR-S%20FM%20Profile%20Designer%20Tool/ Project Deliverables on GForge]
 +
 
 +
[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]
 +
 
 +
[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]
  
 
==How to create a Functional Profile==
 
==How to create a Functional Profile==
 
===How-To Guide===
 
===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 [[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.
 
<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.
−
The guide can be downloaded here [[Media:How-to_Guide_R2_final.pdf]]
+
 
 +
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.
  
 
===Manuals===
 
===Manuals===
−
The EHR-S FM R2 standard is published as a pdf on the HL7 website and is available for everyone. The ERH-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.  
+
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']].
 +
 
 
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.
 
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===
 
===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 ([[Media:ReadtheEHRSFM.pdf]]) and Search the EHR-S FM ([[Media:SearchEHRSFM.pdf]]).
+
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']].
  
−
<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 the manual:  [[Media:TraceabilityElements.pdf]]
+
<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']]
  
 
===Create a Functional Profile===
 
===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 [[0Introduction.pdf]]
+
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  
  
 
<br/>In the manuals 1 to 9 the creation of a Functional Model based on the EHR-S FM is described.  
 
<br/>In the manuals 1 to 9 the creation of a Functional Model based on the EHR-S FM is described.  
 
<br/>1. Create a new project for a new Functional Profile
 
<br/>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. The manual describes how to do this. [[Media:1CreateNewProfile.pdf]]
+
*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/>2. Load a Base Model for creation of a new Functional profile
 
<br/>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 [[2LoadBaseModel.pdf]]. 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.
+
*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/>3. Create package for (compiled) Functional Profile
 
<br/>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 0Introduction chapter, this is represented in figure 2 and 3. [[3CreatePackageforFP.pdf]]
+
*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/>4. Provide General Information
 
<br/>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 [[4ProvideGeneralInformation.pdf]]. However, the general information on the functional Profile is usually described in an Overview chapter that is published together with the Functional Profile itself.
+
*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
 
<br/>5. Create UML model for the new Functional Profile
−
*For the Profile Definition, you need to create a 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 [[5CreateUMLmodelNewFP.pdf]]. Figure 3 in the 0Introduction chapter shows you how this UML model looks like.
+
*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
 
<br/>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 [[6CreateProfileDefinition.pdf]]. 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.
+
*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
 
<br/>7. Create the Compiled Profile
−
*The base for the new Functional Profile is the Profile Definition [[7CreateCompiledProfile.pdf]].
+
*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
 
<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 validation will give you a report on errors and warnings on the work you have done on the Profile Definition or the Compiled Profile [[8Validation.pdf]].
+
*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
 
<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 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 [[9CreatePublication.pdf]].
+
*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 .
 +
 
  
 
===Edit the Functional Profile===
 
===Edit the Functional Profile===
Line 66: Line 94:
  
 
<br/>Adding EHR-S FM components
 
<br/>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 [[AddingEHR_S_FMFPcomponents.pdf]].  
+
*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/>Working in a project on a new functional profile
 
<br/>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 [[CollaborationFunctionalProfile.pdf]].
+
*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/>Moving EHR-S FM Components
 
<br/>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 [[MovingEHR_S_FMFPcomponents.pdf]].
+
*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
 
<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 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 [[ProjectManagement.pdf]].
+
*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
 
<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 track changes in the Profile Definition [[TrackingChanges.pdf]]. See for a detailed description of how to create a Profile Definition chapter [[6CreateProfileDefinition.pdf]].
+
*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]].
−
 
 
  
  
 
===Export during the development process===
 
===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 [[media:ExportSection.pdf|manual 'Export Section']] is described how to create an export for the use of a review.
  
−
===Frequently asked questions, FAQ===
+
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.
−
 
 
−
===MAX Extension===
 
  
−
===Phase 2 Deliverables===
+
How to import the template in EA is described in the manual.
−
It is December the 3th and almost the end of 2013. This description is to give you an update of phase 2 of the EHR-S Tooling project. The project team worked together with the EHR WG on the deliverables described in the PSS. Last Friday, November the 29th we had a meeting as a project team and discussed how to actually build the profiling tool and how the steps in Enterprise would look like. We made a presentation with mockups and published this on Box (the link you can find in Phase 2 Work-in-progress Artifacts.
 
  
−
The deliverables until now are;
+
===Frequently asked questions, FAQ===
−
1. The requirements (deliverable 1 in the PSS): this is approved by both the EHR WG and the Tooling WG.
+
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.
−
2. Validation Rules (deliverable 2 in the PSS): this is approved by both the EHR WG and the Tooling WG.
 
−
3. The types of profiles (deliverable 3 in the PSS): this is apporved by both the EHR WG and the Tooling WG.
 
−
4. Profile Views (deliverable 4 in the PSS): this is approved by the EHR WG.
 
−
 
 
−
All the deliverables can be found on GForge http://gforge.hl7.org/gf/project/ehrsfm_profile/docman/
 
−
 
 
−
===Phase 2 Update April 3th 2014===
 
−
We are busy to implement the requirements that are needed for the creation of a FP with support of the tool. The two examples that we are using for this implementation are RM_ES FP and the MU FP. Both eap files are on box; https://app.box.com/s/938b1c1wuprl52nbpazk
 
−
If you install the latest version of the extension, HL7_FM_EA_Extension 20140328-4.msi, you can open the eap file and look at the model of the FP's. If you want you can play with this.
 
−
 
 
−
How to install the extension is described in EHR_S_FM_TOOL_C2_Installing the extension_v01.pdf
 
−
 
 
−
You will also find some content for the learning center in EA; https://app.box.com/s/oetxahgb9k4emgveaodh
 
−
For now these are pdf documents you can consult for working with the tool at this moment. Before the end of April we will include them in the learning center of EA.
 
−
 
 
−
NOTE: we asked for an extension on the deliverable date (of March 31th) and the WG agreed with this.
 
−
 
 
−
===Phase 2 Update May 12th 2014===
 
−
All the basic requirements for the development of a functional Profile are implemented in the EHR-S FM Profiling Tool. The latest version of the msi extension is HL7_FM_EA_Extension 20140429. The RMES FP and the MU FP were used to implement the requirements and to test the tool. As always work in progress can be found on box: https://app.box.com/s/938b1c1wuprl52nbpazk
 
−
Meanwhile we delivered the next deliverables to HL7 International after approval by both the EHR WG and Tooling WG. These deliverables can be found on GForge (after you logged in): http://gforge.hl7.org/gf/project/ehrsfm_profile/docman/Phase2Deliverables6/
 
−
 
 
−
At this stage the tool can be used to develop a new Functional Profile based on the EHR-S FM R2.0. How to use the tool for that can be found in the user guides also on GForge, but also in the Learning Center in EA (can be consulted after installing the extension).
 
−
However, the tool is still in development, so changes will be made in the upcoming weeks. Changes are improvement of the implementations in the tool, it can happen that there are still bugs in the tool. These improvements will not effect your work.
 
−
Other changes concerns further implementation of the requirements. We are working on the requirements for combine, compare and merge functionalities. Use case for this is the PHFP. These further implementations will not effect your work.
 
−
 
 
−
If you want to use the tool for the development of your functional profile please contact the EHR WG and we can plan a meeting in where we can give you instructions in how to start using the tool.
 
−
 
 
−
===Phase 2 Update September 22th 2014===
 
−
As described in the May update all the basic requirements for the development of a Functional Profile were implemented in the EHR-S FM Profiling Tool. Four significant steps were made since then:
 
−
1. The Meaningful Use Functional Profile (MU FP) was created for the August 2014 ballot.
 
−
2. HL7 Italy uses the tool for the creation of their Realm Functional Profile.
 
−
3. The publication tools and format were developed and used to publish the MU FP and the EHR-S FM for ISO.
 
−
4. Started the implementation of the Combine, Compare and Merge functionality.
 
−
 
 
−
Several issues on the tool and on the rules of creating Functional Profiles were detected while working on the MU FP. All issues detected were included in GForge and fixed in the tool. Also HL7 Italy detected these issues and had issues in the context of using the tool for the development of a Realm Functional Profile. The last ones will be addresses in phase 3 of the tooling project.
 
−
 
 
−
The publication format, tools for that and the steps of how to create a publication were developed and used. A final user guide will be available on Box soon: https://app.box.com/s/v4so451jerv1xicshyox
 
−
 
 
−
For the Combine, Compare and Merge functionality we discussed the requirements and a mockup based on this requirements with the Public Health Functional Profile team. A first (partly) implementation was discussed in the regular EHR WG conference call and showed during the WGM in Chicago. The current implementation status and the direction to finish it were approved by the EHR WG.
 
−
 
 
−
Also the user guides were updated and included in the EA Learning Center and uploaded to box: https://app.box.com/s/oetxahgb9k4emgveaodh . A tutorial presentation was created and used for the hands on sessions during the HL7 WGM in Chicago.
 
−
 
 
−
In the hands-on sessions there were some problems with the tool. One of the problems was related to version 11 of Enterprise Architect (EA). Some participants had this version installed and couldn’t see the costumed learning center and toolbox. However, some had no problems with that.  We will investigate what the reason for this is. Some participants worked with the trail version of EA. Working with this version is not a problem, but saving the work is not possible. For the tutorial in January 2015 we will come up with some pre-requisites because of the experiences from the hands-on sessions.
 
−
 
 
−
As described before, all work in progress can be found on Box: https://app.box.com/s/938b1c1wuprl52nbpazk. The latest version of the msi extension is HL7_FM_EA_Extension v2.14.0915.
 
−
Also the user guides can be found on Box: https://app.box.com/s/oetxahgb9k4emgveaodh
 
−
 
 
−
If you want to use the tool for the development of your functional profile please contact the co-chairs of the EHR WG.
 
−
 
 
−
===Phase 2 Update End October 2014===
 
−
In the EHR WG conference call the following motions were approved:
 
−
 
 
−
'''Motion 1. Electronic Health Record Workgroup is asked to accept an extension of 4 weeks for deliverable 12. Combine, Compare, Merge.'''
 
−
Additional guidance and tool formatting to support profiling tasks such as comparing profiles, comparing functions, merging functions and criteria from separate profiles. The Results 4 Care team used a mock up design and had further discussions with EHR WG members for the functional requirements. The work is significant more difficult than anticipated. We are making progress, but might not make the deadline of Oct 31. ''The EHR WG approved an extension of one month (November the 30th) to finish the implementation of the combine, compare and merge functionality.''
 
−
 
 
−
'''Motion 2.  Electronic Health Record Workgroup is asked to accept deliverable 10: support the work process of profile creators.'''
 
−
 
 
−
 
 
−
'''Motion 3.    Electronic Health Record Workgroup is asked to accept deliverable 11:  Publication artifacts for EHR-S FM profiles using HL7 MAX approach.'''
 
−
 
−
 
 
−
'''Motion 4.    Electronic Health Record Workgroup is asked to accept deliverable 14.  Update reports and wiki contributions.'''
 
−
 
 
−
 
 
−
'''Motion 5.    Electronic Health Record Workgroup is asked to accept deliverable 16.  Tutorial presentation (i.e. pptx) for the profiling tool.'''
 
−
 
 
−
 
 
−
'''Motion 6.    Electronic Health Record Workgroup is asked to accept deliverable 17.  Provide initial support to key WG users in installing and initial use of tool.'''
 
−
 
 
−
See for more detail the minutes of the EHR-WG conference call.
 
−
 
 
−
In order to store all the materials of the EHR-S FM FP Designer Tool Results 4 Care proposed to develop a webpage which can be placed behind the member login of the HL7.org website. On this site the user guides and software can be stored and obtained by HL7 members. An example webpage was developed based on the FHIR webpage of HL7 International. How, by whom etc. will be discussed with HL7 headquarters.
 
−
 
 
−
In the meantime all the final materials can be obtained by contacting the EHR WG co-chairs: http://wiki.hl7.org/index.php?title=EHR_Leadership
 
−
''Note: Box is no longer up to date with the latest materials.''
 
−
 
 
−
===Requirements for webpage to store EHR-S FM artifacts November 2014===
 
−
 
 
−
The purpose of this webpage is to store artifacts in the context of the EHR-S FM FP Designer tool. So it is not the purpose to store the HL7 standard itself, but files the user need to use the tool.
 
−
 
 
−
For the development of the webpage requirements are needed. We will collect the requirements on this wiki during the discussion about the requirements.
 
−
 
 
−
 
 
−
Requirements are:
 
−
*Provide the user interface to:
 
−
**the extension/ the EHR-S FM FP Designer tool.
 
−
**the installation guide of how to install the Extension.
 
−
**the user guides of how to use the tool.
 
−
**the max file of the EHR-S FM R2, latest version.
 
−
**the max files, Profile Definition and Compiled Profile of the Functional Profiles.
 
−
**the eap file of the EHR-S FM R2, latest version.
 
−
**updates on the extension and user guides.
 
−
**a Forum in where users can discuss the functionalities of the tool and/or their experiences with the tool.
 
−
**history of the development progress of the extension.
 
−
 
 
−
 
 
−
===Phase 2 Update December 2014===
 
−
Phase two of the EHR-S FM Profile Designer tool has ended. All the deliverables were delivered in time. In the conference call of the EHR WG the following motions were approved.
 
−
 
 
−
''''''Motion 1.'''  Electronic Health Record (EHR) Workgroup and Electronic Services and Tools (EST) Workgroup are asked to accept deliverable 12.  Combine, Compare, Merge of the Profile Designer Tool.'''
 
−
Additional guidance and tool formatting to support profiling tasks such as comparing profiles, comparing functions, merging functions and criteria from separate profiles. The Results 4 Care team used a mock up design and had further discussions with EHR WG members for the functional requirements. The work took significant more time and energy than anticipated. However, through breaking it down in smaller steps it became possible to continue the work and achieve a working system allowing handling both mergers on profile level, and on individual criteria, based on a component illustrating the differences between profiles. The current set of comparable profiles in one session is 3, which is one more than the required 2 according the original plan for phase 2. It is still possible to combine more through iteration of the process.  The msi file containing this functionality is placed in EHR co-chair Dropbox and in Gforge.
 
−
The materials are available at http://gforge.hl7.org/gf/project/ehrsfm_profile/docman/FinalDeliverablePhase2/
 
−
Please note that some validation files and source code materials are in the SVN.
 
−
 
 
−
'''Motion 2.    Electronic Health Record Workgroup and Electronic Services and Tools (EST) Workgroup are asked to accept deliverable 13:  Final testing of all tool components of the Profile Designer Tool.'''
 
−
The deliverables 1 – 12 will be tested by the EHR and the Tooling workgroup. The EHR WG has been testing the tool through the actual development of FM ballots and FP ballots. These can be seen as acceptance testing of the overall functionality. Many issues and bugs were reported and have been handled by the R4C team. Further, we have created a unit test, and tested the various components. A set of test reports is available. The final test report is placed in EHR co-chair Dropbox and in Gforge.
 
−
The materials are available at http://gforge.hl7.org/gf/project/ehrsfm_profile/docman/FinalDeliverablePhase2/
 
−
 
 
−
'''Motion 3.    Electronic Health Record Workgroup and Electronic Services and Tools (EST) Workgroup are asked to accept deliverable 15.  Final User Guide set for profiling using the Profile Designer Tool.'''
 
−
The R4C team created a range of user guides, one for each significant step in the whole process from starting a project to finalizing the publication. Each user guide has been reviewed by EHR WG members and many have been used during the various demonstrations, workshops, and other events. The set is ready and delivered to the co-chairs due to the copyright arrangements. The last one is about the combine, compare and merge functionality and handed in together with the new tool version that includes this functionality. In addition, R4C created a learning center for the tool using basic EA functionality, and stored the user guides on our server. We created a website with the recent FHIR look and feel to allow HL7 to place both the access page to the learning center plus all user guides and other documentation behind the secure site for members only. HL7 is currently working on the final publication site for members only.
 
−
The user guide and documentation set is placed in the EHR co-chair Dropbox and Gforge
 
−
The materials are available at http://gforge.hl7.org/gf/project/ehrsfm_profile/docman/FinalDeliverablePhase2/
 
−
 
 
−
We still need approval of the EST WG.
 
−
 
 
−
===Past Activities=== 
 
−
#Creation of an EHR Tooling list - Helen
 
−
#Invite Profiling SMEs - John
 
−
#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?
 
  
 
==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

Retrieved from "https://wiki.hl7.org/w/index.php?title=EHRs_FM_Profiling_Tool&oldid=164741"