TerminologyStrategy
Back to Templates Registry Pilot
Rob - you need to fill this in - ask Wendy for instructions. One important aspect is to describe the binding syntax discussion currently happening in the Vocab WG, and describe how it applies to a template registry.
Binding syntax - from HL7 perspective - Core Principles and Properties of V3 Models. Please note this material is going under HL7 normative ballot and is only linked here as a reference guide for binding syntax.
Meta Data Searching
Contents
Searching Capability
Terminology Templates
Code System and Value Set meta data is drawn from the Templates Registry Business Requirement & Templates DSTU 2007 with the exception of Concept Domain - this vocabulary binding methodology was introduced by MnM & Vocab work groups subsequent to the Templates DSTU publication
Code System Template
Element | Type | Conformance | Info | Searchable (Y/N) |
---|---|---|---|---|
Code | String | M | An expression in a syntax defined by the code system which describes the concept. Usually this would be a simple code, but post-coordinated expressions may also be used. | Y |
Code System | String | M | The identity of the codeSystem that defines the syntax and concepts used in the code. This must be a UID, as defined in the rules for the CD.codeSystem property in the V3 abstract datatypes. | Y |
Code System Version | String | O | If applicable, a version descriptor defined specifically for the given code system. For further information, consult the rules for the CD.codeSystemVersion property in the V3 abstract datatypes. | Y |
OID | String | M | A globally unique string representing an ISO identifier for a code system. | Y |
Value Set Template
Element | Type | Conformance | Documentation | Searchable (Y/N) |
---|---|---|---|---|
Value Set Name | String | M | Name of the Value Set | Y |
Binding Strength | Boolean (CNE or CWE) | M | This is to indicate whether the value set can allow for local codes (CWE) or only the exact list of concepts in the value set (CNE). | N |
Concept domain | String | O | Refer to the Concept Domain Template for Concept Domain meta data | Y |
Binding Realm | String | O | If the value set is bound to a concept domain, what is the binding realm e.g. Universal, Example, or Representative.
CD.codeSystemVersion property in the V3 abstract datatypes. |
Y |
OID | String | O | A globally unique string representing an ISO identifier for a value set. | Y |
Description | String | O | Description of the value set | Y |
Concept Domain Template
Element | Conformance | Info | Searchable (Y/N) |
---|---|---|---|
Concept Domain Name | M | Name of the Concept domain | Y |
Concept domain Definition | M | Definition of the concept domain | Y |
Binding Realm | M | Indicates the binding syntax depending which type of binding syntax is done - please refer to the Core Principles and Properties of Version 3 Models, section on Binding Vocabulary To Coded Model Elements. | Y |
Other Data Model Elements
Element | Conformance | Info | Searchable (Y/N) |
---|---|---|---|
Purpose | M | Purpose of the registered artifact in human readable terms. | N |
Identifier | M | Identifier of the artifact registered. | Y |
Source | M | Organization which created the artifact. | Y |
Status | M | Current status of the artifact registered | Y |
Registered Date | M | The date the artifact was registered into the registry. | N |
Effective Date | M | The date the artifact can be actively used and/or search. | N |
Revision Date | M | The most recent date the artifact was revised. | N |
Expiration Date | O | The as of date the artifact is no longer active. | N |