Difference between revisions of "Naming Conventions"

From HL7 TSC
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
  
−
Excerpt and paraphrase from HL7 Governance and Operations Manual (GOM) 12.02.02 01 Constructing Other HL7 Ballot and Protocol Specification Names and HL7 Essential Requirements (HL7 ER)
+
Excerpt and paraphrase from [http://www.hl7.org/permalink/?GOM HL7 Governance and Operations Manual] (GOM) 12.02.01 Constructing Other HL7 Ballot and Protocol Specification Names and [http://www.hl7.org/permalink/?EssentialRequirements HL7 Essential Requirements] (HL7 ER) 02.01.01 Constructing Normative Ballot and Protocol Specification Names
 
The full document name shall begin with an organizational identifier followed by family name, product type and release number with a subfamily name, product type and release number, if applicable, then the product name and release number followed by the realm designation, if applicable, and the ballot type and number. In the case of a reaffirmation ballot the term  “Reaffirmation of” shall precede the family name.
 
The full document name shall begin with an organizational identifier followed by family name, product type and release number with a subfamily name, product type and release number, if applicable, then the product name and release number followed by the realm designation, if applicable, and the ballot type and number. In the case of a reaffirmation ballot the term  “Reaffirmation of” shall precede the family name.
  
−
The naming construct is described below using a notation of {required} or [optional] with literals expressed in <b><i>bold italics </b></i>.
+
The naming construct is described below using a notation of {required} or [optional] with literals expressed in '''''bold italics '''''.
  
  
Line 10: Line 10:
  
 
|-
 
|-
−
| colspan=2 valign="middle" |<b>Ballot Document Name and Information
+
| colspan=2 valign="middle" |Ballot Document Name and Information
  
 
|-
 
|-
−
|colspan=1|Structure
+
|colspan=1|'''Structure'''
−
|Comments</b>
+
|'''Comments '''
 
|-
 
|-
 
|{Organization Identifier}||Organization Identifier shall be:  
 
|{Organization Identifier}||Organization Identifier shall be:  
 +
*HL7/Other [such as NCPDP] indicating an HL7 document published in conjunction with another organization
 
*HL7 indicating a Health Level Seven International document
 
*HL7 indicating a Health Level Seven International document
−
*HL7/Other [such as NCPDP] indicating an HL7 document published in conjunction with another organization         
 
 
|-
 
|-
−
|<b><i>[Reaffirmation of] </b></i>||""|           
+
|'''''[Reaffirmation of] '''''||""|           
 
|-
 
|-
 
| {||One or more of the following 3 line items required  
 
| {||One or more of the following 3 line items required  
 
|-           
 
|-           
−
| [Family Name] [Product Type] [<b><i>Release</b></i> [Release Number]] :
+
| [Family Name] [Product Type] ['''''Release''''' [Release Number]] :
 
|The standard family names are  
 
|The standard family names are  
 
*Version 2.x (V2.x);  
 
*Version 2.x (V2.x);  
Line 30: Line 30:
 
*Clinical Document Architecture® CDA®) [note: CDA shall be further designated as R1 or R2];  
 
*Clinical Document Architecture® CDA®) [note: CDA shall be further designated as R1 or R2];  
 
*Electronic Health Records System-Functional Model (EHRS-FM);  
 
*Electronic Health Records System-Functional Model (EHRS-FM);  
−
*Fast Healthcare Interoperability Resources (FHIR® is the preferred designation);  
+
*Fast Healthcare Interoperability Resources (FHIR®);  
 
*where a document includes reference to two or more family names it may be identified as a Cross Paradigm Specification.  
 
*where a document includes reference to two or more family names it may be identified as a Cross Paradigm Specification.  
 +
<br/>
 +
In the case of a Standard or Standard for Trial Use (STU) the full family name shall be used; e.g. Fast Healthcare Interoperability Resources or Clinical Document Architecture®. In lieu of the full family name the appropriate acronym may be used for Implementation Guides, Profiles, and other documentation.
 +
<br/>
 
<br/>
 
<br/>
 
Product types are defined as  
 
Product types are defined as  
Line 41: Line 44:
 
*Logical Model [note: a Logical Model is not a Cross Paradigm Specification];  
 
*Logical Model [note: a Logical Model is not a Cross Paradigm Specification];  
 
*and Profile.  
 
*and Profile.  
 +
<!--proposed for Jan 2017 GOM: Adding product types: Guidance and White Paper-->
  
 
The TSC may, at their discretion, declare additional product types.
 
The TSC may, at their discretion, declare additional product types.
 
|-   
 
|-   
−
|align="right"| [Sub-family Name] [Product Type] [<b><i>Release</i></b> [Release Number]] ;
+
|align="right"| [Sub-family Name] [Product Type] ['''''Release''''' [Release Number]] ;
 
|align="left"|Subfamily names are specific to a given family and are not further defined in this document.           
 
|align="left"|Subfamily names are specific to a given family and are not further defined in this document.           
 
|-
 
|-
−
|align="right"|[Product Name], [<b><i>Release</b></i> [Release Number]]||""|           
+
|align="right"|[Product Name], ['''''Release''''' [Release Number]]||""|           
 
|-
 
|-
 
| } ||""|  
 
| } ||""|  

Latest revision as of 19:08, 16 November 2016


Excerpt and paraphrase from HL7 Governance and Operations Manual (GOM) 12.02.01 Constructing Other HL7 Ballot and Protocol Specification Names and HL7 Essential Requirements (HL7 ER) 02.01.01 Constructing Normative Ballot and Protocol Specification Names The full document name shall begin with an organizational identifier followed by family name, product type and release number with a subfamily name, product type and release number, if applicable, then the product name and release number followed by the realm designation, if applicable, and the ballot type and number. In the case of a reaffirmation ballot the term “Reaffirmation of” shall precede the family name.

The naming construct is described below using a notation of {required} or [optional] with literals expressed in bold italics .


Ballot Document Name and Information
Structure Comments
{Organization Identifier} Organization Identifier shall be:
  • HL7/Other [such as NCPDP] indicating an HL7 document published in conjunction with another organization
  • HL7 indicating a Health Level Seven International document
[Reaffirmation of]
{ One or more of the following 3 line items required
[Family Name] [Product Type] [Release [Release Number]] : The standard family names are
  • Version 2.x (V2.x);
  • Version 3 (V3) [note: V3 itself does not have a release number, although each of its products typically will];
  • Clinical Document Architecture® CDA®) [note: CDA shall be further designated as R1 or R2];
  • Electronic Health Records System-Functional Model (EHRS-FM);
  • Fast Healthcare Interoperability Resources (FHIR®);
  • where a document includes reference to two or more family names it may be identified as a Cross Paradigm Specification.


In the case of a Standard or Standard for Trial Use (STU) the full family name shall be used; e.g. Fast Healthcare Interoperability Resources or Clinical Document Architecture®. In lieu of the full family name the appropriate acronym may be used for Implementation Guides, Profiles, and other documentation.

Product types are defined as

  • Specification or Standard;
  • Domain Analysis Model (DAM);
  • Functional Model (FM);
  • Functional Profile (FP);
  • Implementation Guide (IG);
  • Logical Model [note: a Logical Model is not a Cross Paradigm Specification];
  • and Profile.

The TSC may, at their discretion, declare additional product types.

[Sub-family Name] [Product Type] [Release [Release Number]] ; Subfamily names are specific to a given family and are not further defined in this document.
[Product Name], [Release [Release Number]]
}
[ - Realm Designation] HL7 Version 3 Standard > Vocabulary > HL7 Value Sets > HL7 Realm
Retrieved from "https://tscwiki.hl7.org/w/index.php?title=Naming_Conventions&oldid=17808"