HL7 Terminology
2.0.0 - Publication

This page is part of the HL7 Terminology (v2.0.0: Release) based on FHIR R4. The current version which supercedes this version is 5.2.0. For a full list of available versions, see the Directory of published versions

CodeSystem: UTG Specific Concept Properties

Summary

Defining URL:http://terminology.hl7.org/CodeSystem/utg-concept-properties
Version:2.0.0
Name:ConceptProperties
Title:UTG Specific Concept Properties
Status:Draft as of 2020-11-07T09:27:49+11:00
Definition:

A set of concept properties used by UTG to maintain legacy terminology distribution systems

Publisher:UTG Project
Content:Complete: All the concepts defined by the code system are included in the code system resource
Source Resource:XML / JSON / Turtle

This Code system is referenced in the content logical definition of the following value sets:

This CodeSystem is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Properties

CodeURLDescriptionType
commenthttp://hl7.org/fhir/concept-properties#commentVComments and notes on the Domain.string

This code system http://terminology.hl7.org/CodeSystem/utg-concept-properties defines the following codes:

CodeDisplayDefinitioncomment
v2-binding V2 Binding CodeCoded value identifying the binding realm for those tables that have a binding to a value set. 0=no binding or binding N/A; 1=Example; 2=Representative; 3=Universal; 4=US Realm.used only in v2-tables.xml
v2-cld V2 VS CLD TypeCategorization of Content Logical Definition for the V2 value set informing the table, as printed in the V2 ballot. 0=no expansion, 1=all codes, 2=enumerated, 3=V3 vaue set definition, 4=unique intensional definition, 5=non-HL7 value set definition, 6=FHIR value set definitionUsed only for value sets informing the coded content of HL7 V2 tables. There are only a few types of value set compose statements for V2, and this code indicates now the exapnsion for puisblishing is to be caclulated.
v2-cs-oid V2 Code System OIDOID of the code system associated with the tableused only in v2-tables.xml
v2-cs-uri V2 Code System URIURI of the code system associated with the tableused only in v2-tables.xml
v2-vs-uri V2 Value Set URIURI of the value set informing the content of the tableused only in v2-tables.xml
v2-table-deprecated deprecatedIndicates that although still being published in the V2 international standard, the table has been deprecated in favor of alternative codes, and will be withdrawn in the future.used only in v2-tables.xml
v2TblStatus V2 Table StatusStatus of the table as published in the V2 ballots. This is different from the concept status, which is the status of the concept representing the table infomration in the V2 Tables code system.Used only in v2-tables.xml
steward Steward WorkGroupsteward workgroup for the tableused only in v2-tables.xml
v2-table-oid V2 Table OIDOID value for the table objectused only in v2-tables.xml
v2-table-type V2 Table TypeType of V2 table, e.g. HL7 or Userused only in v2-tables.xml
v2-cs-version V2 Code System VersionVersion of the code system informing the table. Note this is a denormused only in v2-tables.xml
v2-version-tbl-introduced version-tbl-introducedHL7 V2 version when the V2 Table was introducedUsed only in v2-tables.xml
v2-version-csvs-introduced version-csvs-introducedHL7 V2 version when the code system and value set were introduced. This is either the creation date of the V2 code system or value set objects, or the date when the FHIR or V3 or External code system and/or value set were associated to the table.used only in v2-tables.xml
vocab-domain Concept DomainAssociated Concept Domain for the tableused only in v2-tables.xml
v2-vs-oid V2 Value Set OIDOID of the value set informing the tableused only in v2-tables.xml
v2-where-used Field Where UsedString holding the segment and field where the table is bound in the interational standard.used only in v2-tables.xml
rim-classifies-class-code ClassifiesC RIM Class CodeAssociates a concept domain with th ActClass code that it is intended to be associated with, ie for late binding, informs the IG devloper which code should be populated in ActClass when a value sset for ActCode is being bound.used only in concept domains; in the coremif called 'ConceptualSpaceForClassCode'
rim-qualified-by May Be QualifiedB yOne of the types of concept relationships that implements qualifying relationshipsThis needs reexamination to see how it is represented in UTG and if it correct; in V3 relationships between concepts in the same code system are represented internal to the system, not as a map. Note that we have an extension for code systems for 'conceptrelationshipkind'
rim-inbound-relationship Name:Act:inboundRelationship:ActRelationshipName of inboundRelationship from Act to ActRelnused only in structural code system content
rim-outbound-relationship Name:Act:outboundRelationship:ActRelationshipFormal name of outboundRelationship from Act to ActRelnused only in structural code system content
rim-participation Name:Act:participation:ParticipationName of relationship from Act to Participationused only in structural code system content
rim-ActRelationship-source Name:ActRelationship:source:ActThe name of the assciation from ActRelationship to the source Actused only in structural code system content
rim-ActRelationship-target Name:ActRelationship:target:ActThe name of the assciation from ActRelationship to the source Actused only in structural code system content
rim-Class Name:ClassThe formal name for the class clone under this codeused only in structural code system content
rim-Entity-played Name:Entity:playedRole:RoleThe name of the relationship from the Entity to the playedRoleused only in structural code system content
rim-Entity-scoped Name:Entity:scopedRole:RoleThe name of the relationship from the Entity to the scopedRoleused only in structural code system content
rim-Participation-act Name:Participation:act:ActThe formal name for relationship from Participation to Actused only in structural code system content
rim-Participation-role Name:Participation:role:RoleThe name of the relationship from Participation to Roleused only in structural code system content
rim-Role-inbound Name:Role:inboundLink:RoleLinkName of inboundLink relationship from Role to RoleLinkused only in structural code system content
rim-Role-outbound Name:Role:outboundLink:RoleLinkName of outboundLink relationship from Role to RoleLinkused only in structural code system content
rim-Role-participation Name:Role:participation:ParticipationName of relationship from Role to Participationused only in structural code system content
rim-Role-player Name:Role:player:EntityThe name of the relationship from Role to the payer Entityused only in structural code system content
rim-Role-scoper Name:Role:scoper:EntityThe name of the relationship from Role to the scoper Entityused only in structural code system content
v3-cs-oid OIDProperty applies to concepts in the CodeSystem Code System. The property holds the OID that uniquely identifies the code system represented by this coded concept.This code system of code systems was retired a long time ago, and should not be in UTG so this property is unnecessary
owning-affiliate OwningAffiliateProperty defined in V3 tooling, but may not be currently used.not certain where this came from
owning-section OwningSectionProperty defined in V3 tooling, but may not be currently used.not certain where this came from
owning-subsection OwningSubSectionProperty defined in V3 tooling, but may not be currently used.not certain where this came from
v3-smaller-than SmallerThanProperty defined in V3 tooling, but may not be currently used.not certain where this came from
rim-Act-inbound-sort Sort:Act:inboundRelationship:ActRelationshipSort key for the inboundRelationship from Act to ActReln; used to publish the RIM
rim-act-outbound-sort Sort:Act:outboundRelationship:ActRelationshipSort key for the outboundRelationship from Act to ActReln; used to publish the RIM
rim-Act-participation-sort Sort:Act:participation:ParticipationSort key for relationship from Act to Participation; used to publish the RIM
rim-Entity-played-sort Sort:Entity:playedRole:RoleSort key for the relationship from the Entity to the playedRole; used to publish the RIM
rim-Entity-scoped-sort Sort:Entity:scopedRole:RoleThe sort key for the relationship from the Entity to the scopedRole; used to publish the RIM
rim-Role-inbound-sort Sort:Role:inboundLink:RoleLinkSort key for inboundLink relationship from Role to RoleLink; used to publish the RIM
rim-Role-outbound-sort Sort:Role:outboundLink:RoleLinkSort key for outboundLink relationship from Role to RoleLink; used to publish the RIM
rim-Role-participation-sort Sort:Role:participation:ParticipationSort key for relationship from Role to Participation; used to publish the RIM
v3-applies-to appliesToHaven't a clue!used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms.
rim-conductible conductibleIf true, indicates that ActRelationships or Participations of the specified type (and any specializations thereof) will normally conduct. For more usage information, refer to the Core Principles specification.
v3-how-applies howAppliesHaven't a clue!used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms.
v3-internal-id internalIdThe internal identifier for the concept in the HL7 Access database repository.this should not be migrated to UTG
v3-inverse-relationship inverseRelationshipProperty applies to the ConceptCodeRelationship code system. For each concept, it identifies the name of the inverse relationship.only used in the code system of contept relationships.. Forgot we had this. Not sure how it should be modeled in UTG.
rim-document-characteristic isDocumentCharacteristicIf true, indicates that the Act attribute or association (as represented by a typeCode for eaither ActRelationship or Pareticipation is a descriptor of the document (record) represented by the act object. If false, indicates the property is a descriptor of the action itself, actual, intended, or potential. Applies to interpretation of attributes and associations with respect to changes in the value of Act.actionNegationInd and Act.moodCode. (See descriptions of these attributes for further discussion.) For example, in an order, the id attribute [isDocumentCharacteristic = true] is an identifier of the record of the order, not an identifier of the intended event. On the other hand, the code attribute [isDocumentCharacteristic = false] describes a characteristic of the intended event.This may not behave the same based on the final outcome from the negation project. Or this may be the impleentation of their recommendations; need to discuss with Rob Hausam. Clear the this is used as part of RIM documentation. Note that this is only used in these two structural code systems.
ConceptualSpaceForClassCode Conceptual Space For ClassCodeThis concept domain provides the semantic category space indicates by the identifies Class code. Used in HL7 V3 RIM.Only used in the V3 RIM concept domains. Identifies the class code that should be used in either ActClass or EntityClass when this domain is the terminology constraint for ActCode or EntityCode attribute
source SourceIndicaates the etiology of this domain, i.e. which HL7 product family or other area that the domain originally was needed for and triggered its creation.Current values are v2, v3, cda. Note the ones for CDA have been added manually.
openIssue Open IssueDocuments some V3 issue that was never resolved for a particular concept domain.Currently valued only for the v3 Concept Domains, and reflect open issues to be addressed in various concept domains. May be used for open issues on particular concepts in code systems later.
deprecationInfo Deprecation InformationDocumentation of V3 concept domains that have been deprecated.Currently valued only for the v3 Concept Domains. Includes commentary and release IDs when they were deprecated, and possibly replacement information
contextBindingUV-valueSet UV Bound ValueSetIdentifies the Value Set bound to this Concept Domain in the Universal Realm.
contextBindingUV-effectiveDate UV Binding Effective DateEffective Date of the specified Value Set bound to this Concwpt Domain in the Universal Realm.
contextBindingUV-strength UV Binding Coding StrengthCoding strength for the Universal Realm binding; either CWE or CNE.
contextBindingR1-valueSet R1 Bound ValueSetIdentifies the Value Set bound to this Concept Domain in the Representative Realm.R1 Bindings have been implemented in at least one Realm, and are offered for general use as they may be valid in other Realms.
contextBindingR1-effectiveDate R1 Binding Effective DateEffective Date of the specified Value Set bound to this Concept Domain in the Representative Realm.
contextBindingR1-strength R1 Binding Coding StrengthCoding strength for the Representatie binding; either CWE or CNE.
contextBindingX1-valueSet X1 Bound ValueSetIdentifies the Value Set bound to this Concept Domain in the Example Realm.X1 Bindings are used solely for published or educational examples, and are known to be incorrect or invalid content for real world systems. They should not be used in production systems.
contextBindingX1-effectiveDate X1 Binding Effective DateEffective Date of the specified Value Set bound to this Concept Domain in the Example Realm.
contextBindingX1-strength X1 Binding Coding StrengthCoding strength for the Example binding; either CWE or CNE.
contextBindingC1-valueSet C1 Bound ValueSetIdentifies the Value Set bound to this Concept Domain in the Example Realm.C1 Bindings are used solely for provisional or draft bindings, and are intended to be removed or updated at some tiem in the future. In general, C1 bindings may be incorrect or invalid content for real world systems, or may be subject to change without notice. They should not be used in production systems.
contextBindingC1-effectiveDate C1 Binding Effective DateEffective Date of the specified Value Set bound to this Concept Domain in the Unclassified Realm.
contextBindingC1-strength C1 Binding Coding StrengthCoding strength for the Example binding; either CWE or CNE.
contextBindingUS-valueSet US Bound ValueSetIdentifies the Value Set bound to this Concept Domain in the US (United States of America) Realm.
contextBindingUS-effectiveDate US Binding Effective DateEffective Date of the specified Value Set bound to this Concwpt Domain in the US Realm.
contextBindingUS-strength US Binding Coding StrengthCoding strength for the US Realm binding; either CWE or CNE.
rim-assoc-conc-property Assoc Concpt PropertyFormal code of an Associated Concept Property.Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content.
rim-assoc-conc-propname Assoc Concpt Prop NameFormal name of an Associated Concept Property.Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content.
rim-assoc-conc-propvalue Assoc Concpt Prop ValueValue of an Associated Concept Property.Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content.
v2-concComment V2 Concept CommentString value from the V2 publishing database source holding comments for the concepts for populated tables. These comments are separate from the concept Definition and the Usage Notes.used only in Version 2 code systems concepts
v2-concCommentAsPub V2 Concept Comment As PublishedString value from the V2 publishing database source holding comments as published for the concepts for populated tables. These comments are separate from the concept Definition and the Usage Notes, and may be distinct from the other comments due to publishing requirements.used only in Version 2 code systems concepts
HL7usageNotes HL7 Concept Usage NotesString value from the HL7 sources holding the Usage Notes for the concepts for populated tables and code systems. These are separate from the concept Definitions and the other comments.used only in the Version 2 code systems concepts
propIsMandatory RIM Property is MandatoryBoolean indicating when an attribure of a RIM class attribute is mandatory.Used as a property of a property, in RIM Class Codes primarily.
propDefaultValue Default value of RIM PropertyString holding an optional default value for a mandatory property.Used as a property of a property, in RIM Class Codes primarily.
propDefaultHandling Default handling of RIM PropertyCode value identifying the default handling code of a RIM attribute mandatory property.Used as a property of a property, in RIM Class Codes primarily.
rim-ClassifiesClassCode Concept Domain that classifies a RIM Class CodeCode value from a RIM Class such as ActClass or EntityClass which the Domain classifies.Used as a property of a property, in RIM Class Codes primarily.
ComponentOf Special additional relationship for part relatioshipsCode value identifying the code in the codeSystem which this concept is a component of.Used as a property of a property, in RIM Class Codes primarily.
MayBeQualifiedBy Qualifier relationshipCode value identifying another code in the codeSystem which this concept may be qualified byUsed as a property of a property, in RIM Class Codes primarily.
OwningSubSection Subsection containment relationshipUsed in the V3 publication process, indicates a ballot subsection which encloses this content.Used as a property of a property, in RIM Class Codes primarily.
OwningSection Section containment relationshipUsed in the V3 publication process, indicates a ballot section which encloses this content.Used as a property of a property, in RIM Class Codes primarily.
OwningAffiliate HL7 Affiliate OwnerUsed in the V3 ballot and publication process to indicate content which is owned by one of the HL7 International Affiliates.Used as a property of a property, in RIM Class Codes primarily.
DeprecationInfo Deprecation InformatonUsed to support the capture of comments, remarks, V3 release ID, and other information related to the deprecation of a concept.Used primarily to hold the imported comments and release version information on deprecated concepts in the V3 coremif.
SmallerThan Smaller ThanPoints to another code value in the codeSystem which this concept is smaller than. Typically used in systems of Ordinal relationship codes, where size or magnitude is the ordering key.Used as a property of a property, in RIM Class Codes primarily.

History

DateActionAuthorCustodianComment
2020-07-31reviseTed KleinVocabulary WGTechnical correction: UP-85 add property to support coremif required deprecation informaton on concepts
2020-05-18reviseTed KleinVocabulary WGFix the v2 tables status property name
2020-05-06reviseTed KleinVocabulary WGMigrated to the UTG maintenance environment and publishing tooling.