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

Difference between revisions of "Concept Domain Naming Conventions"

From HL7Wiki
Jump to navigation Jump to search
Line 5: Line 5:
 
When naming Concept Domains, the following naming conventions will be applied:
 
When naming Concept Domains, the following naming conventions will be applied:
  
* Concept Domain names shall begin with the applicable parent class name as appropriate.
+
* Concept Domain names shall begin with the applicable parent '''class name''' as appropriate.
  
 
* Concept Domains shall end with '''Type'''
 
* Concept Domains shall end with '''Type'''

Revision as of 21:31, 8 June 2009

Overview

Naming Conventions

When naming Concept Domains, the following naming conventions will be applied:

  • Concept Domain names shall begin with the applicable parent class name as appropriate.
  • Concept Domains shall end with Type


Act Examples

Where PrintName is the name of the domain being considered for addition, the following examples attempt to illustrate the application of the naming conventions.

ActReason

ActReason -> ActPrintName'ReasonType

ActConsentType

ActConsentType -> ActPrintNameConsentType

ObservationType Subdomain

ObservationType -> ActPrintNameObservationType


Role and Entity Examples

For the RoleCode and EntityClass concept domains, the concatenation of the Class and Type strings will be added as a suffix to the PrintName.

RoleCode

RoleCode -> PrintName'RoleType'

SpecializedRoleType -> PrintNameSpecializedRoleType

EntityCode

EntityCode -> PrintName'EntityType'

SpecializedEntityType -> PrintNameSpecializedEntityType

Backwards Compatibility

There will be no effort to modify existing concept domains to adhere to the naming conventions specified here. Any modification of an existing domain name will necessitate an update to all models making use of that domain. For the time being, this effort is considered unreasonable and focus will be directed at ensuring new domains are named in accordance with the recommended naming conventions.