This wiki has undergone a migration to Confluence found Here

Difference between revisions of "V2.x refactor requirements"

From HL7Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
'''V2 refactoring project - Project insight Id ???? '''
 
'''V2 refactoring project - Project insight Id ???? '''
This page is the starting point for the refactoring
+
 
 +
This page is the starting point for the refactoring.
 +
 
 +
The primary goal is to bring the specification to the state of the art in writing interface specifications. As such, it can be devided into primary and secondary goals:
 +
 
 +
# enhance the way the specification is written, making it compatible with other like V3/CDA and FHIR, at least as far as possible
 +
# increased functionality for the user
 +
 
 
=Project Scope Statement=
 
=Project Scope Statement=
 
The project scope statement is at [http://wiki.hl7.org/images/4/4b/HL7_Project_Scope_Statement_V2_Refactor.docx V2 Refactor PSS]
 
The project scope statement is at [http://wiki.hl7.org/images/4/4b/HL7_Project_Scope_Statement_V2_Refactor.docx V2 Refactor PSS]
  
=Requirements analysis=
+
=Primary Goals=
 +
* use of state-fo-the-art technical terminology
 +
** eliminate "required but may be empty" and similar terms
 +
** use of vocabulary approaches (instead of "tables")
 +
*** vocabulary domain
 +
*** value set
 +
*** codesystem
 +
 
 +
*smaller chapters
 +
** easier to edit
 +
** easier to find volunteers
 +
* provide complete v2 family
 +
*web-technology
 +
 
 +
=Secondary Goals=
 +
==Requirements analysis==
 
* overarching requirements
 
* overarching requirements
==User requirements==
+
 
 +
===User requirements===
 
* Requirements from the user perspective
 
* Requirements from the user perspective
 
** Ability to edit content without regard for special markup
 
** Ability to edit content without regard for special markup
==Publishing requirements==
+
** Access to the newest version
 +
** special editing functionality for v2 specific tables
 +
*** segments
 +
*** message structure
 +
*** data types
 +
*** vocabulary
 +
 
 +
===Publishing requirements===
 
* Requirements from the publishing perspective
 
* Requirements from the publishing perspective
==Tooling Requirements==
+
** provide web-based version
 +
** generate complete documentation
 +
 
 +
===Tooling Requirements===
 
* Requirements for tooling
 
* Requirements for tooling
 
**[[Publishing_Requirements_-_ARB | Tooling Requirements]]
 
**[[Publishing_Requirements_-_ARB | Tooling Requirements]]
==Conceptual model==
+
 
 +
===Conceptual model===
 
* Conceptual modeling
 
* Conceptual modeling
==Logical model==
+
** "official" v2 model
 +
 
 +
===Logical model===
 
* Logical modeling
 
* Logical modeling
==Physical model==
+
 
 +
===Physical model===
 
* Physical modeling
 
* Physical modeling

Latest revision as of 15:46, 18 November 2015

V2 refactoring project - Project insight Id ????

This page is the starting point for the refactoring.

The primary goal is to bring the specification to the state of the art in writing interface specifications. As such, it can be devided into primary and secondary goals:

  1. enhance the way the specification is written, making it compatible with other like V3/CDA and FHIR, at least as far as possible
  2. increased functionality for the user

Project Scope Statement

The project scope statement is at V2 Refactor PSS

Primary Goals

  • use of state-fo-the-art technical terminology
    • eliminate "required but may be empty" and similar terms
    • use of vocabulary approaches (instead of "tables")
      • vocabulary domain
      • value set
      • codesystem
  • smaller chapters
    • easier to edit
    • easier to find volunteers
  • provide complete v2 family
  • web-technology

Secondary Goals

Requirements analysis

  • overarching requirements

User requirements

  • Requirements from the user perspective
    • Ability to edit content without regard for special markup
    • Access to the newest version
    • special editing functionality for v2 specific tables
      • segments
      • message structure
      • data types
      • vocabulary

Publishing requirements

  • Requirements from the publishing perspective
    • provide web-based version
    • generate complete documentation

Tooling Requirements

Conceptual model

  • Conceptual modeling
    • "official" v2 model

Logical model

  • Logical modeling

Physical model

  • Physical modeling