This wiki has undergone a migration to Confluence found Here

Version 2 Table Project Guidelines

From HL7Wiki
Jump to navigation Jump to search

Rules for Review and Assignment of V2.x Tables

HL7 V2 Tables and HL7 V3 Concept Domains

The name of every HL7 V2.x table will represent the name of a HL7 V3 Concept Domain. HL7 V3 Concept Domains will be created with names as similar as possible to their corresponding Version 2 artifacts. (9-June-2011 Minutes)

HL7 V2.x "User" tables with No Suggested Values will be represented as a Concept Domain only (no code systems or value sets). (9-June-2011 Minutes)

HL7 V2 Tables and HL7 V3 Code Systems

  • Every V2 table is uniquely identified by the Table Number which is consistent across all versions of V2 publications.
  • HL7 V2.x Tables that have associated values that are HL7 authored and published in an HL7 V2 Standard will be HL7 V3 Code Systems. (9-June-2011 minutes, 27-Sept-2013 minutes)
  • HL7 V3 code systems that are created from the enumerated values of V2 code tables will be registered as Type 18 OIDs. (9-June-2011 Minutes)

New HL7 V3 Code Systems

  • Any change to the domain (semantic boundary) of an HL7 V2 table will result in a new HL7 V3 Code System. (9-June-2011 Minutes) This will result in having multiple HL7 V3 code systems that correspond to a single V2 table. (23-June-2011 minutes)
Example: A specific V2 table in publication 2.3.1 may not be the same V3 code system as the same V2 table in publication 2.4. (27-Sept-2013 minutes)

HL7 V3 Code System Versions

Glossary

  • HL7 V3 Code system version: specific persisted state of a HL7 V3 code system (27-Sept-2013 minutes)
  • HL7 V3 Code system version identifier: designator of a HL7 V3 code system version (27-Sept-2013 minutes)

Rules

  • In the first HL7 published V2 standard in which a table with values is introduced, the HL7 V3 code system version identifier is "1". (23-June-2011 minutes, 5-Sept-2013 minutes, 27-Sept-2013 minutes)
  • When there is a new version of the HL7 V3 Code System, its HL7 V3 code system version identifier will be incremented by 1. (23-June-2011 minutes, 27-Sept-2013 minutes)
  • For any HL7 2.x publication, if the list of values in a particular table is the same as the list of values in the previous HL7 2.x publication, the HL7 V3 code system version remains the same. (23-June-2011 minutes, 27-Sept-2013 minutes)
  • If new values have been added to a table in an HL7 2.x publication that do not change the meaning of any of the existing values in the table, this results in a new version of the HL7 V3 Code System. (23-June-2011 minutes, 27-Sept-2013 minutes)
  • If the list of values in a table in an HL7 2.x publication has new values added as the only change, no change to the meaning of the values that are the same as in the previous HL7 version, there is no new HL7 V3 Code System, just a new version of the HL7 V3 Code System. (23-June-2011 minutes, 27-Sept-2013 minutes)


  • If in the course of successive HL7 Standard versions, the encoding of concepts in a particular table changes, there is a new HL7 V3 Code System; this is not only just a new HL7 V3 Code System Version. (23-June-2011 minutes)
  • HL7 V3 Code system versions have an effective version identifier, which is the HL7 standard version ID as carried in the message header. Once they have been superseded by a new version, they will also have the retired version identifier. (5-Sept-2013 minutes)

HL7 V2 Tables and HL7 V3 Value Sets

HL7 V2.x Tables that have associated values are HL7 V3 Value Set. (9-June-2011 minutes)

The Value Sets defined as "all codes" from the code systems built from the V2 standard tables will be Type 21 OIDs. (9-June-2011 minutes, 22-August-2013 minutes)

HL7 V2 Tables and HL7 V3 Bindings

HL7 V2.x "HL7" Tables have a UV (Universal) binding between the Concept Domain and the Value Set. (9-June-2011 Minutes)

HL7 V2.x "HL7" Table bindings have a coding strength of Coded With Exceptions (CWE), with the following exceptions (9-June-2011 Minutes):

  • exception 1
  • exception 2

HL7 V2.x "User" Tables have either a Representative realm (R1) or an Example realm (X1) binding between the Concept Domain and the Value Set. The binding decisions are arbitrary based upon the perception and consensus agreement by the review group of the completeness of domain coverage by the published set of codes. (9-June-2011 Minutes)

HL7 V2.x "User" Table bindings have a coding strength of Coded With Exceptions (CWE), with the following exceptions (9-June-2011 Minutes):

  • exception 1
  • exception 2