<status value="draft"/> <experimental value="false"/> <date value="2023-07-17T22:16:15-06:00"/> <publisher value="UTG Project"/> <description value="A set of concept properties used by UTG to maintain legacy terminology distribution systems"/> <caseSensitive value="true"/> <content value="complete"/> <property> <code value="comment"/> <uri value="http://hl7.org/fhir/concept-properties#comment"/> <description value="VComments and notes on the Domain."/> <type value="string"/> </property> <concept> <code value="v2-binding"/> <display value="V2 Binding Code"/> <definition value="Coded 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."/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-cld"/> <display value="V2 VS CLD Type"/> <definition value="Categorization 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 definition"/> <property> <code value="comment"/> <valueString value="Used 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."/> </property> </concept> <concept> <code value="v2-cs-oid"/> <display value="V2 Code System OID"/> <definition value="OID of the code system associated with the table"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-cs-uri"/> <display value="V2 Code System URI"/> <definition value="URI of the code system associated with the table"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-vs-uri"/> <display value="V2 Value Set URI"/> <definition value="URI of the value set informing the content of the table"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-table-deprecated"/> <display value="deprecated"/> <definition value="Indicates 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."/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2TblStatus"/> <display value="V2 Table Status"/> <definition value="Status 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."/> <property> <code value="comment"/> <valueString value="Used only in v2-tables.xml"/> </property> </concept> <concept> <code value="steward"/> <display value="Steward WorkGroup"/> <definition value="Steward Work Group for the concept and its tree of subconcepts."/> <property> <code value="comment"/> <valueString value="This is the HL7 Work Group primarily responsible for the content of the artifact."/> </property> </concept> <concept> <code value="v2-table-oid"/> <display value="V2 Table OID"/> <definition value="OID value for the table object"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-table-type"/> <display value="V2 Table Type"/> <definition value="Type of V2 table, e.g. HL7 or User"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-cs-version"/> <display value="V2 Code System Version"/> <definition value="Version of the code system informing the table. Note this is a denorm"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-version-tbl-introduced"/> <display value="version-tbl-introduced"/> <definition value="HL7 V2 version when the V2 Table was introduced"/> <property> <code value="comment"/> <valueString value="Used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-version-csvs-introduced"/> <display value="version-csvs-introduced"/> <definition value="HL7 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."/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="vocab-domain"/> <display value="Concept Domain"/> <definition value="Associated Concept Domain for the table"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-vs-oid"/> <display value="V2 Value Set OID"/> <definition value="OID of the value set informing the table"/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="v2-where-used"/> <display value="Field Where Used"/> <definition value="String holding the segment and field where the table is bound in the interational standard."/> <property> <code value="comment"/> <valueString value="used only in v2-tables.xml"/> </property> </concept> <concept> <code value="rim-classifies-class-code"/> <display value="ClassifiesC RIM Class Code"/> <definition value="Associates 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."/> <property> <code value="comment"/> <valueString value="used only in concept domains; in the coremif called 'ConceptualSpaceForClassCode'"/> </property> </concept> <concept> <code value="rim-qualified-by"/> <display value="May Be QualifiedB y"/> <definition value="One of the types of concept relationships that implements qualifying relationships"/> <property> <code value="comment"/> <valueString value="This 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'"/> </property> </concept> <concept> <code value="rim-inbound-relationship"/> <display value="Name:Act:inboundRelationship:ActRelationship"/> <definition value="Name of inboundRelationship from Act to ActReln"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-outbound-relationship"/> <display value="Name:Act:outboundRelationship:ActRelationship"/> <definition value="Formal name of outboundRelationship from Act to ActReln"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-participation"/> <display value="Name:Act:participation:Participation"/> <definition value="Name of relationship from Act to Participation"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-ActRelationship-source"/> <display value="Name:ActRelationship:source:Act"/> <definition value="The name of the assciation from ActRelationship to the source Act"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-ActRelationship-target"/> <display value="Name:ActRelationship:target:Act"/> <definition value="The name of the assciation from ActRelationship to the source Act"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Class"/> <display value="Name:Class"/> <definition value="The formal name for the class clone under this code"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Entity-played"/> <display value="Name:Entity:playedRole:Role"/> <definition value="The name of the relationship from the Entity to the playedRole"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Entity-scoped"/> <display value="Name:Entity:scopedRole:Role"/> <definition value="The name of the relationship from the Entity to the scopedRole"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Participation-act"/> <display value="Name:Participation:act:Act"/> <definition value="The formal name for relationship from Participation to Act"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Participation-role"/> <display value="Name:Participation:role:Role"/> <definition value="The name of the relationship from Participation to Role"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Role-inbound"/> <display value="Name:Role:inboundLink:RoleLink"/> <definition value="Name of inboundLink relationship from Role to RoleLink"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Role-outbound"/> <display value="Name:Role:outboundLink:RoleLink"/> <definition value="Name of outboundLink relationship from Role to RoleLink"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Role-participation"/> <display value="Name:Role:participation:Participation"/> <definition value="Name of relationship from Role to Participation"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Role-player"/> <display value="Name:Role:player:Entity"/> <definition value="The name of the relationship from Role to the payer Entity"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="rim-Role-scoper"/> <display value="Name:Role:scoper:Entity"/> <definition value="The name of the relationship from Role to the scoper Entity"/> <property> <code value="comment"/> <valueString value="used only in structural code system content"/> </property> </concept> <concept> <code value="v3-cs-oid"/> <display value="OID"/> <definition value="Property applies to concepts in the CodeSystem Code System. The property holds the OID that uniquely identifies the code system represented by this coded concept."/> <property> <code value="comment"/> <valueString value="This code system of code systems was retired a long time ago, and should not be in UTG so this property is unnecessary"/> </property> </concept> <concept> <code value="owning-affiliate"/> <display value="OwningAffiliate"/> <definition value="Property defined in V3 tooling, but may not be currently used."/> <property> <code value="comment"/> <valueString value="not certain where this came from"/> </property> </concept> <concept> <code value="owning-section"/> <display value="OwningSection"/> <definition value="Property defined in V3 tooling, but may not be currently used."/> <property> <code value="comment"/> <valueString value="not certain where this came from"/> </property> </concept> <concept> <code value="owning-subsection"/> <display value="OwningSubSection"/> <definition value="Property defined in V3 tooling, but may not be currently used."/> <property> <code value="comment"/> <valueString value="not certain where this came from"/> </property> </concept> <concept> <code value="v3-smaller-than"/> <display value="SmallerThan"/> <definition value="Property defined in V3 tooling, but may not be currently used."/> <property> <code value="comment"/> <valueString value="not certain where this came from"/> </property> </concept> <concept> <code value="rim-Act-inbound-sort"/> <display value="Sort:Act:inboundRelationship:ActRelationship"/> <definition value="Sort key for the inboundRelationship from Act to ActReln; used to publish the RIM"/> </concept> <concept> <code value="rim-act-outbound-sort"/> <display value="Sort:Act:outboundRelationship:ActRelationship"/> <definition value="Sort key for the outboundRelationship from Act to ActReln; used to publish the RIM"/> </concept> <concept> <code value="rim-Act-participation-sort"/> <display value="Sort:Act:participation:Participation"/> <definition value="Sort key for relationship from Act to Participation; used to publish the RIM"/> </concept> <concept> <code value="rim-Entity-played-sort"/> <display value="Sort:Entity:playedRole:Role"/> <definition value="Sort key for the relationship from the Entity to the playedRole; used to publish the RIM"/> </concept> <concept> <code value="rim-Entity-scoped-sort"/> <display value="Sort:Entity:scopedRole:Role"/> <definition value="The sort key for the relationship from the Entity to the scopedRole; used to publish the RIM"/> </concept> <concept> <code value="rim-Role-inbound-sort"/> <display value="Sort:Role:inboundLink:RoleLink"/> <definition value="Sort key for inboundLink relationship from Role to RoleLink; used to publish the RIM"/> </concept> <concept> <code value="rim-Role-outbound-sort"/> <display value="Sort:Role:outboundLink:RoleLink"/> <definition value="Sort key for outboundLink relationship from Role to RoleLink; used to publish the RIM"/> </concept> <concept> <code value="rim-Role-participation-sort"/> <display value="Sort:Role:participation:Participation"/> <definition value="Sort key for relationship from Role to Participation; used to publish the RIM"/> </concept> <concept> <code value="v3-applies-to"/> <display value="appliesTo"/> <definition value="Haven't a clue!"/> <property> <code value="comment"/> <valueString value="used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms."/> </property> </concept> <concept> <code value="rim-conductible"/> <display value="conductible"/> <definition value="If 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."/> </concept> <concept> <code value="v3-how-applies"/> <display value="howApplies"/> <definition value="Haven't a clue!"/> <property> <code value="comment"/> <valueString value="used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms."/> </property> </concept> <concept> <code value="v3-internal-id"/> <display value="internalId"/> <definition value="The internal identifier for the concept in the HL7 Access database repository."/> <property> <code value="comment"/> <valueString value="this should not be migrated to UTG"/> </property> </concept> <concept> <code value="v3-inverse-relationship"/> <display value="inverseRelationship"/> <definition value="Property applies to the ConceptCodeRelationship code system. For each concept, it identifies the name of the inverse relationship."/> <property> <code value="comment"/> <valueString value="only used in the code system of contept relationships.. Forgot we had this. Not sure how it should be modeled in UTG."/> </property> </concept> <concept> <code value="rim-document-characteristic"/> <display value="isDocumentCharacteristic"/> <definition value="If 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."/> <property> <code value="comment"/> <valueString value="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."/> </property> </concept> <concept> <code value="ConceptualSpaceForClassCode"/> <display value="Conceptual Space For ClassCode"/> <definition value="This concept domain provides the semantic category space indicates by the identifies Class code. Used in HL7 V3 RIM."/> <property> <code value="comment"/> <valueString value="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"/> </property> </concept> <concept> <code value="source"/> <display value="Source"/> <definition value="Indicaates 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."/> <property> <code value="comment"/> <valueString value="Current values are v2, v3, cda. Note the ones for CDA have been added manually."/> </property> </concept> <concept> <code value="openIssue"/> <display value="Open Issue"/> <definition value="Documents some V3 issue that was never resolved for a particular concept domain."/> <property> <code value="comment"/> <valueString value="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."/> </property> </concept> <concept> <code value="deprecationInfo"/> <display value="Deprecation Information"/> <definition value="Documentation of V3 concept domains that have been deprecated."/> <property> <code value="comment"/> <valueString value="Currently valued only for the v3 Concept Domains. Includes commentary and release IDs when they were deprecated, and possibly replacement information"/> </property> </concept> <concept> <code value="contextBindingUV-valueSet"/> <display value="UV Bound ValueSet"/> <definition value="Identifies the Value Set bound to this Concept Domain in the Universal Realm."/> </concept> <concept> <code value="contextBindingUV-effectiveDate"/> <display value="UV Binding Effective Date"/> <definition value="Effective Date of the specified Value Set bound to this Concwpt Domain in the Universal Realm."/> </concept> <concept> <code value="contextBindingUV-strength"/> <display value="UV Binding Coding Strength"/> <definition value="Coding strength for the Universal Realm binding; either CWE or CNE."/> </concept> <concept> <code value="contextBindingR1-valueSet"/> <display value="R1 Bound ValueSet"/> <definition value="Identifies the Value Set bound to this Concept Domain in the Representative Realm."/> <property> <code value="comment"/> <valueString value="R1 Bindings have been implemented in at least one Realm, and are offered for general use as they may be valid in other Realms."/> </property> </concept> <concept> <code value="contextBindingR1-effectiveDate"/> <display value="R1 Binding Effective Date"/> <definition value="Effective Date of the specified Value Set bound to this Concept Domain in the Representative Realm."/> </concept> <concept> <code value="contextBindingR1-strength"/> <display value="R1 Binding Coding Strength"/> <definition value="Coding strength for the Representatie binding; either CWE or CNE."/> </concept> <concept> <code value="contextBindingX1-valueSet"/> <display value="X1 Bound ValueSet"/> <definition value="Identifies the Value Set bound to this Concept Domain in the Example Realm."/> <property> <code value="comment"/> <valueString value="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."/> </property> </concept> <concept> <code value="contextBindingX1-effectiveDate"/> <display value="X1 Binding Effective Date"/> <definition value="Effective Date of the specified Value Set bound to this Concept Domain in the Example Realm."/> </concept> <concept> <code value="contextBindingX1-strength"/> <display value="X1 Binding Coding Strength"/> <definition value="Coding strength for the Example binding; either CWE or CNE."/> </concept> <concept> <code value="contextBindingC1-valueSet"/> <display value="C1 Bound ValueSet"/> <definition value="Identifies the Value Set bound to this Concept Domain in the Example Realm."/> <property> <code value="comment"/> <valueString value="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."/> </property> </concept> <concept> <code value="contextBindingC1-effectiveDate"/> <display value="C1 Binding Effective Date"/> <definition value="Effective Date of the specified Value Set bound to this Concept Domain in the Unclassified Realm."/> </concept> <concept> <code value="contextBindingC1-strength"/> <display value="C1 Binding Coding Strength"/> <definition value="Coding strength for the Example binding; either CWE or CNE."/> </concept> <concept> <code value="contextBindingUS-valueSet"/> <display value="US Bound ValueSet"/> <definition value="Identifies the Value Set bound to this Concept Domain in the US (United States of America) Realm."/> </concept> <concept> <code value="contextBindingUS-effectiveDate"/> <display value="US Binding Effective Date"/> <definition value="Effective Date of the specified Value Set bound to this Concwpt Domain in the US Realm."/> </concept> <concept> <code value="contextBindingUS-strength"/> <display value="US Binding Coding Strength"/> <definition value="Coding strength for the US Realm binding; either CWE or CNE."/> </concept> <concept> <code value="rim-assoc-conc-property"/> <display value="Assoc Concpt Property"/> <definition value="Formal code of an Associated Concept Property."/> <property> <code value="comment"/> <valueString value="Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content."/> </property> </concept> <concept> <code value="rim-assoc-conc-propname"/> <display value="Assoc Concpt Prop Name"/> <definition value="Formal name of an Associated Concept Property."/> <property> <code value="comment"/> <valueString value="Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content."/> </property> </concept> <concept> <code value="rim-assoc-conc-propvalue"/> <display value="Assoc Concpt Prop Value"/> <definition value="Value of an Associated Concept Property."/> <property> <code value="comment"/> <valueString value="Used only in the V3 RIM, and required for Formal Naming. Also needed for proper operation of RoseTree in display of cormif content."/> </property> </concept> <concept> <code value="v2-concComment"/> <display value="V2 Concept Comment"/> <definition value="String 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."/> <property> <code value="comment"/> <valueString value="used only in Version 2 code systems concepts"/> </property> </concept> <concept> <code value="v2-concCommentAsPub"/> <display value="V2 Concept Comment As Published"/> <definition value="String 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."/> <property> <code value="comment"/> <valueString value="used only in Version 2 code systems concepts"/> </property> </concept> <concept> <code value="HL7usageNotes"/> <display value="HL7 Concept Usage Notes"/> <definition value="String 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."/> <property> <code value="comment"/> <valueString value="used only in the Version 2 code systems concepts"/> </property> </concept> <concept> <code value="propIsMandatory"/> <display value="RIM Property is Mandatory"/> <definition value="Boolean indicating when an attribure of a RIM class attribute is mandatory."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="propDefaultValue"/> <display value="Default value of RIM Property"/> <definition value="String holding an optional default value for a mandatory property."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="propDefaultHandling"/> <display value="Default handling of RIM Property"/> <definition value="Code value identifying the default handling code of a RIM attribute mandatory property."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="rim-ClassifiesClassCode"/> <display value="Concept Domain that classifies a RIM Class Code"/> <definition value="Code value from a RIM Class such as ActClass or EntityClass which the Domain classifies."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="ComponentOf"/> <display value="Special additional relationship for part relatioships"/> <definition value="Code value identifying the code in the codeSystem which this concept is a component of."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="MayBeQualifiedBy"/> <display value="Qualifier relationship"/> <definition value="Code value identifying another code in the codeSystem which this concept may be qualified by"/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="OwningSubSection"/> <display value="Subsection containment relationship"/> <definition value="Used in the V3 publication process, indicates a ballot subsection which encloses this content."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="OwningSection"/> <display value="Section containment relationship"/> <definition value="Used in the V3 publication process, indicates a ballot section which encloses this content."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="OwningAffiliate"/> <display value="HL7 Affiliate Owner"/> <definition value="Used in the V3 ballot and publication process to indicate content which is owned by one of the HL7 International Affiliates."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> <concept> <code value="DeprecationInfo"/> <display value="Deprecation Informaton"/> <definition value="Used to support the capture of comments, remarks, V3 release ID, and other information related to the deprecation of a concept."/> <property> <code value="comment"/> <valueString value="Used primarily to hold the imported comments and release version information on deprecated concepts in the V3 coremif."/> </property> </concept> <concept> <code value="SmallerThan"/> <display value="Smaller Than"/> <definition value="Points 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."/> <property> <code value="comment"/> <valueString value="Used as a property of a property, in RIM Class Codes primarily."/> </property> </concept> </CodeSystem>

Properties

This code system defines the following properties for its concepts

Code

URI

Type

Description

comment

http://hl7.org/fhir/concept-properties#comment

string

VComments and notes on the Domain.

Concepts

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

Code	Display	Definition	comment
v2-binding	V2 Binding Code	Coded 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 Type	Categorization 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 definition	Used 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 OID	OID of the code system associated with the table	used only in v2-tables.xml
v2-cs-uri	V2 Code System URI	URI of the code system associated with the table	used only in v2-tables.xml
v2-vs-uri	V2 Value Set URI	URI of the value set informing the content of the table	used only in v2-tables.xml
v2-table-deprecated	deprecated	Indicates 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 Status	Status 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 WorkGroup	Steward Work Group for the concept and its tree of subconcepts.	This is the HL7 Work Group primarily responsible for the content of the artifact.
v2-table-oid	V2 Table OID	OID value for the table object	used only in v2-tables.xml
v2-table-type	V2 Table Type	Type of V2 table, e.g. HL7 or User	used only in v2-tables.xml
v2-cs-version	V2 Code System Version	Version of the code system informing the table. Note this is a denorm	used only in v2-tables.xml
v2-version-tbl-introduced	version-tbl-introduced	HL7 V2 version when the V2 Table was introduced	Used only in v2-tables.xml
v2-version-csvs-introduced	version-csvs-introduced	HL7 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 Domain	Associated Concept Domain for the table	used only in v2-tables.xml
v2-vs-oid	V2 Value Set OID	OID of the value set informing the table	used only in v2-tables.xml
v2-where-used	Field Where Used	String 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 Code	Associates 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 y	One of the types of concept relationships that implements qualifying relationships	This 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:ActRelationship	Name of inboundRelationship from Act to ActReln	used only in structural code system content
rim-outbound-relationship	Name:Act:outboundRelationship:ActRelationship	Formal name of outboundRelationship from Act to ActReln	used only in structural code system content
rim-participation	Name:Act:participation:Participation	Name of relationship from Act to Participation	used only in structural code system content
rim-ActRelationship-source	Name:ActRelationship:source:Act	The name of the assciation from ActRelationship to the source Act	used only in structural code system content
rim-ActRelationship-target	Name:ActRelationship:target:Act	The name of the assciation from ActRelationship to the source Act	used only in structural code system content
rim-Class	Name:Class	The formal name for the class clone under this code	used only in structural code system content
rim-Entity-played	Name:Entity:playedRole:Role	The name of the relationship from the Entity to the playedRole	used only in structural code system content
rim-Entity-scoped	Name:Entity:scopedRole:Role	The name of the relationship from the Entity to the scopedRole	used only in structural code system content
rim-Participation-act	Name:Participation:act:Act	The formal name for relationship from Participation to Act	used only in structural code system content
rim-Participation-role	Name:Participation:role:Role	The name of the relationship from Participation to Role	used only in structural code system content
rim-Role-inbound	Name:Role:inboundLink:RoleLink	Name of inboundLink relationship from Role to RoleLink	used only in structural code system content
rim-Role-outbound	Name:Role:outboundLink:RoleLink	Name of outboundLink relationship from Role to RoleLink	used only in structural code system content
rim-Role-participation	Name:Role:participation:Participation	Name of relationship from Role to Participation	used only in structural code system content
rim-Role-player	Name:Role:player:Entity	The name of the relationship from Role to the payer Entity	used only in structural code system content
rim-Role-scoper	Name:Role:scoper:Entity	The name of the relationship from Role to the scoper Entity	used only in structural code system content
v3-cs-oid	OID	Property 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	OwningAffiliate	Property defined in V3 tooling, but may not be currently used.	not certain where this came from
owning-section	OwningSection	Property defined in V3 tooling, but may not be currently used.	not certain where this came from
owning-subsection	OwningSubSection	Property defined in V3 tooling, but may not be currently used.	not certain where this came from
v3-smaller-than	SmallerThan	Property defined in V3 tooling, but may not be currently used.	not certain where this came from
rim-Act-inbound-sort	Sort:Act:inboundRelationship:ActRelationship	Sort key for the inboundRelationship from Act to ActReln; used to publish the RIM
rim-act-outbound-sort	Sort:Act:outboundRelationship:ActRelationship	Sort key for the outboundRelationship from Act to ActReln; used to publish the RIM
rim-Act-participation-sort	Sort:Act:participation:Participation	Sort key for relationship from Act to Participation; used to publish the RIM
rim-Entity-played-sort	Sort:Entity:playedRole:Role	Sort key for the relationship from the Entity to the playedRole; used to publish the RIM
rim-Entity-scoped-sort	Sort:Entity:scopedRole:Role	The sort key for the relationship from the Entity to the scopedRole; used to publish the RIM
rim-Role-inbound-sort	Sort:Role:inboundLink:RoleLink	Sort key for inboundLink relationship from Role to RoleLink; used to publish the RIM
rim-Role-outbound-sort	Sort:Role:outboundLink:RoleLink	Sort key for outboundLink relationship from Role to RoleLink; used to publish the RIM
rim-Role-participation-sort	Sort:Role:participation:Participation	Sort key for relationship from Role to Participation; used to publish the RIM
v3-applies-to	appliesTo	Haven't a clue!	used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms.
rim-conductible	conductible	If 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	howApplies	Haven't a clue!	used only in ObservationMethod, and appears to link types of tests with equipment, manufacturers, reagents, or organisms.
v3-internal-id	internalId	The internal identifier for the concept in the HL7 Access database repository.	this should not be migrated to UTG
v3-inverse-relationship	inverseRelationship	Property 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	isDocumentCharacteristic	If 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 ClassCode	This 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	Source	Indicaates 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 Issue	Documents 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 Information	Documentation 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 ValueSet	Identifies the Value Set bound to this Concept Domain in the Universal Realm.
contextBindingUV-effectiveDate	UV Binding Effective Date	Effective Date of the specified Value Set bound to this Concwpt Domain in the Universal Realm.
contextBindingUV-strength	UV Binding Coding Strength	Coding strength for the Universal Realm binding; either CWE or CNE.
contextBindingR1-valueSet	R1 Bound ValueSet	Identifies 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 Date	Effective Date of the specified Value Set bound to this Concept Domain in the Representative Realm.
contextBindingR1-strength	R1 Binding Coding Strength	Coding strength for the Representatie binding; either CWE or CNE.
contextBindingX1-valueSet	X1 Bound ValueSet	Identifies 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 Date	Effective Date of the specified Value Set bound to this Concept Domain in the Example Realm.
contextBindingX1-strength	X1 Binding Coding Strength	Coding strength for the Example binding; either CWE or CNE.
contextBindingC1-valueSet	C1 Bound ValueSet	Identifies 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 Date	Effective Date of the specified Value Set bound to this Concept Domain in the Unclassified Realm.
contextBindingC1-strength	C1 Binding Coding Strength	Coding strength for the Example binding; either CWE or CNE.
contextBindingUS-valueSet	US Bound ValueSet	Identifies the Value Set bound to this Concept Domain in the US (United States of America) Realm.
contextBindingUS-effectiveDate	US Binding Effective Date	Effective Date of the specified Value Set bound to this Concwpt Domain in the US Realm.
contextBindingUS-strength	US Binding Coding Strength	Coding strength for the US Realm binding; either CWE or CNE.
rim-assoc-conc-property	Assoc Concpt Property	Formal 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 Name	Formal 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 Value	Value 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 Comment	String 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 Published	String 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 Notes	String 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 Mandatory	Boolean 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 Property	String 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 Property	Code 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 Code	Code 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 relatioships	Code 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 relationship	Code value identifying another code in the codeSystem which this concept may be qualified by	Used as a property of a property, in RIM Class Codes primarily.
OwningSubSection	Subsection containment relationship	Used 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 relationship	Used 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 Owner	Used 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 Informaton	Used 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 Than	Points 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.