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
Line 77: Line 77:
  
 
===Current Functional List===
 
===Current Functional List===
 +
The following list contains all thus far identified functionality in general order of priority (greatest to least)
  
#Start with source R2</li>
+
===Input ''(not specific to this project, but defined through from EHR-S FM development and publication)''===
#Source R2 in XML
+
*EHR-S FM R2 source in XML
#Note - will not support R1.1.  Is it necesary to convert R1/R1.1 to R2?
 
  
# +Browse & Navigation of the funtional model
 
# ++search capabilities, filtering capabilities, keyword search, search & replace.
 
# ++output formats?  HTML?
 
# + output format PDF?
 
# + output format xml?
 
# - output format HL7 HTML publication format (i.e. to publish through HL7 Publishing)
 
  
# -Need to be able to generate publication ready documents.
+
===Absolute Functionality ''(Top Priority)''===
# -Attach frontmatter to publication. Chapter 1
+
# Enforce profiling rules (per Conformance Chapter)
# -- mobile access
+
## Include/Exclude functions from profile
# Include, exclude</li>
+
## Conformance Optionality
# +++ Enforce profiling rules (per Conformance Chapter)</li>
+
## Conditional Criteria
# ++ Add functions and criteria</li>
+
## Criteria Inheritance
# ++ Modify functions and criteria</li>
+
## Add functions and criteria
# - Maintain original for comparison with modified function/criteria</li>
+
## Modify functions and criteria
# + ability to revert to previous state (undo)
+
##... ''(Other absolute profile rules)''
# - Compare to other profiles</li>
+
# output formats
# - Merge Functions/Criteria from separate Profiles</li>
+
## HTML
# - Export Sections from Master or working copy</li>
+
## PDF
# + simple text copy paste
+
## XML
# + text formatting (highlight, bold, underline, fonting, italisize)
+
# Browse & Navigation of the funtional model
# - Function copy paste 
+
## search capabilities, filtering capabilities, keyword search, search & replace.
# + Show dependencies between functions/criteria</li>
+
# 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)
## + Show impact of changes</li>
+
# Save profile
## + Undo changes</li>
 
# - Balloting & reconciliation tracibility 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.
 
# + Capture comments against an element (ie. a criteria/function)
 
# + Initialize to new releases (clear old comments, reset to clean restart to new version activity)
 
## ++ Separate the content from the tool so that we can import/export versions.
 
## ++ backup and archive and save - normal database management stuff.
 
# - converting a profile from one version to the next.
 
## - If you have a profile based on R2.o, have the tool update baseline profile to R2.1 as starting point.
 
# - Requirements regarding tooling access (online)
 
## - Suport multi user - multiple users working on same profile at same time?
 
## - User Management, access control
 
# - Workflow management tool (assigning activities to users)
 
# + Ability to link functional model/profile to be linked to a conceptual model (bi-directionally)
 
  
 +
 +
===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]]====
 
====[[EHR-S FM Profiling Tool: Working Documents|Additional Working Documents]]====

Revision as of 04:44, 18 January 2012

EHR-S FM Profiling Tool Project

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

Project Overview


This project, sponsored by the HL7 Tooling Workgroup and co-sponsored by the EHR Workgroup, will produce a (web-based and/or 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:

  • shall support multiple platforms, Windows, Linux, MacOS.
  • be available via OHT.
  • There is a defined XML exchange format that is used by at least one other tool (e.g. Import the FM in Enterprise Architect).


This tool will become a tool in the HL7 suite of tools.
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

Project Need

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.

Project Success Criteria

  • Capable of producing fully conformant EHR-S FM profiles, which may be ballotted.
  • Supports exportation of profiles as a document, a computable interchange format (XML), a spreadsheet and a hyperlinked html document.
  • Supports importation of profiles via the defined interchange format.
  • The tool is used in the EHR-S FM Tutorial.
  • Supports Functional Models that support the EHR WG specifications (e.g. Personal Health Record System (PHR-S FM) with the same model schema.
  • Tooling is supported by the HL7 tooling workgroup as part of the HL7 suite of tools.

Currently Out of Scope

Other related tooling
- Model balloting, balloting, reconciliation, and publishing
- MIF
- Desc ???
- Links ???

Project Leaders

Corey Spears
John Ritter
Michael van der Zel

Meeting Information

Conference Calls
None scheduled

Project Documents

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

Project Plan Draft

This project is slated to follow an iterative development pattern. Below is an initial draft for the first iteration.

  1. Functional requirement definition
    • EHR-S FM Chapter 2 (Conformance rules - Tool business rules)
    • Define user experience requirements
    • Functional Brainstorm and Survey (define initial release functional requirements
  2. Existing tool analysis
  3. Functional Specification
  4. Technical Specification
  5. Development
  6. Testing
  7. Release


Current Activities


Creation of an EHR Tooling list - Helen
Suggestions mechanism - Michael
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)

  1. Enforce profiling rules (per Conformance Chapter)
    1. Include/Exclude functions from profile
    2. Conformance Optionality
    3. Conditional Criteria
    4. Criteria Inheritance
    5. Add functions and criteria
    6. Modify functions and criteria
    7. ... (Other absolute profile rules)
  2. output formats
    1. HTML
    2. PDF
    3. XML
  3. Browse & Navigation of the funtional model
    1. search capabilities, filtering capabilities, keyword search, search & replace.
  4. 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)
  5. Save profile


Needed Functionality (High priority)

  1. Ability to revert to previous state (undo)
  2. Simple text copy paste (text editor related)
  3. Text formatting (highlight, bold, underline, font, italicize
  4. Show dependencies between functions/criteria
    1. Show impact of changes
  5. Undo changes
  6. Capture comments regarding specific elements (i.e. comments regarding specific functions or criteria)
  7. Initialize/revert to conformant base standard (clear old comments, reset to clean restart to new version activity)
  8. Ability to link functional model/profile (intra/inter base standard and profile, linked to a conceptual model, bi-directionally)


Operative Functionality (Medium Priority)

  1. Output format HL7 HTML publication format (i.e. to publish through HL7 Publishing)
    1. Generate publication ready documents.
  2. Attach front-matter to publication. Chapter 1 (Additional material
  3. Maintain original for comparison with modified function/criteria
  4. Compare to other profiles
  5. Merge Functions/Criteria from separate Profiles
  6. Export Sections from Master or working copy
  7. Function copy paste
  8. Balloting & reconciliation traceability version control
    1. Managing voting and input from reviewers.
    2. Reporting out all comments against an element.
  9. Capturing institutional memory "allow for comments/notes" attached to elements.
  10. converting a profile from one version to the next.
    1. If you have a profile based on R2.0, have the tool update baseline profile to R2.1 as starting point.
  11. Requirements regarding tooling access (online)
    1. Support multi user - multiple users working on same profile at same time?
    2. User Management, access control
  12. Workflow management tool (assigning activities to users)


Additional Functionality (Low Priority)

  1. mobile access
  • Note - will not support R1.1. Is it necessary to convert R1/R1.1 to R2?

Additional Working Documents

Listserv

The EHR-S FM Profiling Tool Project is currently being set up.
To subscribe to a list service, please go to the HL7 Listservices Welcome Page