Properties

CodeURLTypeDescription
SpecializesCodingThe child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric.
GeneralizesCodingInverse of Specializes. Only included as a derived relationship.
internalIdhttp://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-idcodeThe internal identifier for the concept in the HL7 Access database repository.
statushttp://hl7.org/fhir/concept-properties#statuscodeDesignation of a concept's state. Normally is not populated unless the state is retired.

This code system http://terminology.hl7.org/CodeSystem/v3-HL7DefinedRoseProperty defines the following codes:

CodeDisplayDefinitioninternalIdstatus
ApplicationRoleI Application RoleHolds the unique identifier of an Application Role (stereotype of class).10085active
Cardinality Attribute CardinalityRecords the constraints on the cardinality of attributes as documented in the RIM and in MIMs.10086active
DeleteFromMIM MIM DeleteUsed in constructing a Message Information Model to indicate which attributes to omit from the MIM.10087active
DevelopingCommit Developing committeeHolds the id of the HL7 committee developing the model like "C00."10103active
DTsymbol Data type symbolHolds the symbol for a defined data type (stereotype of class).10096active
EndState End stateThe HL7 MDF says that leaf level use cases should be connected to a state transition of the subject class. The use case diagram provides the link to the subject class. The modeler must use three properties to identify the state transition -- this property and the two following ones named StartState and StateTransition. The first two are, as their names imply, the names of the starting state and ending state of the transition, and the third is the name of the transition.10112active
HMD HMD identifierThe identifier of the HMD from which the message structure for the message transferred by an interaction is drawn.10100active
ID IdentifierHolds the unique identifier of use cases, interactions and storyboards.10115active
InstancedDTsymbo Data type instantiatedHolds the data type assigned to the generic type parameter when an instantiation of generic type is recorded.10097active
IsPrimitiveDT Primitive data typeIndicates that a data type definition is for a primitive data type (stereotype of class).10098active
IsReferenceDT Reference data typeIndicates that the type for a data type component (attribute of a data type stereotype of class) is found by reference.10099active
IsSubjectClass Subject classSet true for classes that are subject classes.10094active
MandatoryInclusi MandatoryIndicates with a value of "True" whether the inclusion of an attribute in an HMD and in the messages derived from that HMD is mandatory. The default is not mandatory, and use of mandatory inclusion in the RIM is deprecated.10088active
MayRepeat Attribute may repeatIndicates with values of "True" or "False" whether an attribute may repeat in an HMD. The default is non-repeating.10089active
MIM_id MIM IdentifierUsed in a subject area category that holds a MIM. It provides the unique identifier for the MIM. The first portion of this identifier should be the ModelID of the RIM from which the MIM is derived.10110active
ModelDate Model dateA text version of the last modified date formatted like "19970606"10104active
ModelDescription Model descriptionContains the textual description of the model.10105active
ModelID Model identifierHolds the unique identifier assigned to this model.10106active
ModelName Model nameHolds the formal name for the model10107active
ModelVersion Model versionA text version of the version number like "V 30-08"10108active
MsgID Message type identifierThe identifier of the message structure within the HMD (above) that defines the message transferred by an interaction.10101active
Organization Developing organizationThis is the organization defining the model, "Health\_Level\_Seven"10109active
RcvResp Receiver responsibilityThis property holds the identifier of the follow-on interaction, when the receiving application role for an interaction has the responsibility to initiate a follow-on interaction.10102active
RespComm_id Responsible committee IDCaptures the identifier of the responsible committee for all subject areas and categories.10111active
StartState Start state(See description of EndState above).10113active
StateAttribute State attributeFor classes that are subject classes, this component provides the name of the state attribute for the class. Only one state attribute component may appear for a given class.10095active
StateTransition State transition(See description of EndState above.)10114active
V23_Datatype Version 2 data typeThis component can document the Version 2.3 datatype for an attribute that is related to or derived from data fields in HL7 Version 2.3.10092active
V23_Fields Version 2 Field referenceThis component provides a reference to the source Version 2.x field for an attribute that is related to or derived from data fields in HL7 Version 2.3 standard. Concatenate multiple values with commas, if multiple references to Version 2.x exist for an attribute.10093active
Vocab_domain Vocabulary domainCaptures the identifier (name) of the vocabulary domain that constrains the values of coded attributes. This property is captured both for RIM attributes and in MIMs.10090active
Vocab_strength Vocabulary strengthCaptures the strength of encoding for the elements of a coded attribute. This property is captured both for RIM attributes and in MIMs.10091active
zhxID History identifierThis component tracks the version history of each element of the model. It contains the unique element identifier assigned to each model element. The repository assigns values for this element. Modelers should not change these values or assign new ones, but they may copy them to indicate an element's historic predecessor.10084active
<status value="retired"/> <experimental value="false"/> <date value="2019-03-20"/> <publisher value="Health Level 7"/> <contact> <name value="Health Level Seven"/> </contact> <description value="The property Ids that HL7 has defined for customizing Rational Rose. **Deprecation Comment:** Deprecated as per 11/2008 Harmonization cleanup; internal and obsolete HL7 usage, no longer used."/> <caseSensitive value="true"/> <hierarchyMeaning value="is-a"/> <content value="complete"/> <property> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry"> <valueCode value="antisymmetric"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity"> <valueCode value="transitive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity"> <valueCode value="irreflexive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable"> <valueBoolean value="true"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind"> <valueCode value="Specializes"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName"> <valueString value="Generalizes"/> </extension> <code value="Specializes"/> <description value="The child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric."/> <type value="Coding"/> </property> <property> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry"> <valueCode value="antisymmetric"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity"> <valueCode value="transitive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity"> <valueCode value="irreflexive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable"> <valueBoolean value="true"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind"> <valueCode value="Generalizes"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName"> <valueString value="Specializes"/> </extension> <code value="Generalizes"/> <description value="Inverse of Specializes. Only included as a derived relationship."/> <type value="Coding"/> </property> <property> <code value="internalId"/> <uri value="http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id"/> <description value="The internal identifier for the concept in the HL7 Access database repository."/> <type value="code"/> </property> <property> <code value="status"/> <uri value="http://hl7.org/fhir/concept-properties#status"/> <description value="Designation of a concept's state. Normally is not populated unless the state is retired."/> <type value="code"/> </property> <concept> <code value="ApplicationRoleI"/> <display value="Application Role"/> <definition value="Holds the unique identifier of an Application Role (stereotype of class)."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10085"/> </property> </concept> <concept> <code value="Cardinality"/> <display value="Attribute Cardinality"/> <definition value="Records the constraints on the cardinality of attributes as documented in the RIM and in MIMs."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10086"/> </property> </concept> <concept> <code value="DeleteFromMIM"/> <display value="MIM Delete"/> <definition value="Used in constructing a Message Information Model to indicate which attributes to omit from the MIM."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10087"/> </property> </concept> <concept> <code value="DevelopingCommit"/> <display value="Developing committee"/> <definition value="Holds the id of the HL7 committee developing the model like "C00.""/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10103"/> </property> </concept> <concept> <code value="DTsymbol"/> <display value="Data type symbol"/> <definition value="Holds the symbol for a defined data type (stereotype of class)."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10096"/> </property> </concept> <concept> <code value="EndState"/> <display value="End state"/> <definition value="The HL7 MDF says that leaf level use cases should be connected to a state transition of the subject class. The use case diagram provides the link to the subject class. The modeler must use three properties to identify the state transition -- this property and the two following ones named StartState and StateTransition. The first two are, as their names imply, the names of the starting state and ending state of the transition, and the third is the name of the transition."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10112"/> </property> </concept> <concept> <code value="HMD"/> <display value="HMD identifier"/> <definition value="The identifier of the HMD from which the message structure for the message transferred by an interaction is drawn."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10100"/> </property> </concept> <concept> <code value="ID"/> <display value="Identifier"/> <definition value="Holds the unique identifier of use cases, interactions and storyboards."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10115"/> </property> </concept> <concept> <code value="InstancedDTsymbo"/> <display value="Data type instantiated"/> <definition value="Holds the data type assigned to the generic type parameter when an instantiation of generic type is recorded."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10097"/> </property> </concept> <concept> <code value="IsPrimitiveDT"/> <display value="Primitive data type"/> <definition value="Indicates that a data type definition is for a primitive data type (stereotype of class)."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10098"/> </property> </concept> <concept> <code value="IsReferenceDT"/> <display value="Reference data type"/> <definition value="Indicates that the type for a data type component (attribute of a data type stereotype of class) is found by reference."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10099"/> </property> </concept> <concept> <code value="IsSubjectClass"/> <display value="Subject class"/> <definition value="Set true for classes that are subject classes."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10094"/> </property> </concept> <concept> <code value="MandatoryInclusi"/> <display value="Mandatory"/> <definition value="Indicates with a value of "True" whether the inclusion of an attribute in an HMD and in the messages derived from that HMD is mandatory. The default is not mandatory, and use of mandatory inclusion in the RIM is deprecated."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10088"/> </property> </concept> <concept> <code value="MayRepeat"/> <display value="Attribute may repeat"/> <definition value="Indicates with values of "True" or "False" whether an attribute may repeat in an HMD. The default is non-repeating."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10089"/> </property> </concept> <concept> <code value="MIM_id"/> <display value="MIM Identifier"/> <definition value="Used in a subject area category that holds a MIM. It provides the unique identifier for the MIM. The first portion of this identifier should be the ModelID of the RIM from which the MIM is derived."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10110"/> </property> </concept> <concept> <code value="ModelDate"/> <display value="Model date"/> <definition value="A text version of the last modified date formatted like "19970606""/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10104"/> </property> </concept> <concept> <code value="ModelDescription"/> <display value="Model description"/> <definition value="Contains the textual description of the model."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10105"/> </property> </concept> <concept> <code value="ModelID"/> <display value="Model identifier"/> <definition value="Holds the unique identifier assigned to this model."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10106"/> </property> </concept> <concept> <code value="ModelName"/> <display value="Model name"/> <definition value="Holds the formal name for the model"/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10107"/> </property> </concept> <concept> <code value="ModelVersion"/> <display value="Model version"/> <definition value="A text version of the version number like "V 30-08""/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10108"/> </property> </concept> <concept> <code value="MsgID"/> <display value="Message type identifier"/> <definition value="The identifier of the message structure within the HMD (above) that defines the message transferred by an interaction."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10101"/> </property> </concept> <concept> <code value="Organization"/> <display value="Developing organization"/> <definition value="This is the organization defining the model, "Health\_Level\_Seven""/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10109"/> </property> </concept> <concept> <code value="RcvResp"/> <display value="Receiver responsibility"/> <definition value="This property holds the identifier of the follow-on interaction, when the receiving application role for an interaction has the responsibility to initiate a follow-on interaction."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10102"/> </property> </concept> <concept> <code value="RespComm_id"/> <display value="Responsible committee ID"/> <definition value="Captures the identifier of the responsible committee for all subject areas and categories."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10111"/> </property> </concept> <concept> <code value="StartState"/> <display value="Start state"/> <definition value="(See description of EndState above)."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10113"/> </property> </concept> <concept> <code value="StateAttribute"/> <display value="State attribute"/> <definition value="For classes that are subject classes, this component provides the name of the state attribute for the class. Only one state attribute component may appear for a given class."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10095"/> </property> </concept> <concept> <code value="StateTransition"/> <display value="State transition"/> <definition value="(See description of EndState above.)"/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10114"/> </property> </concept> <concept> <code value="V23_Datatype"/> <display value="Version 2 data type"/> <definition value="This component can document the Version 2.3 datatype for an attribute that is related to or derived from data fields in HL7 Version 2.3."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10092"/> </property> </concept> <concept> <code value="V23_Fields"/> <display value="Version 2 Field reference"/> <definition value="This component provides a reference to the source Version 2.x field for an attribute that is related to or derived from data fields in HL7 Version 2.3 standard. Concatenate multiple values with commas, if multiple references to Version 2.x exist for an attribute."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10093"/> </property> </concept> <concept> <code value="Vocab_domain"/> <display value="Vocabulary domain"/> <definition value="Captures the identifier (name) of the vocabulary domain that constrains the values of coded attributes. This property is captured both for RIM attributes and in MIMs."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10090"/> </property> </concept> <concept> <code value="Vocab_strength"/> <display value="Vocabulary strength"/> <definition value="Captures the strength of encoding for the elements of a coded attribute. This property is captured both for RIM attributes and in MIMs."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10091"/> </property> </concept> <concept> <code value="zhxID"/> <display value="History identifier"/> <definition value="This component tracks the version history of each element of the model. It contains the unique element identifier assigned to each model element. The repository assigns values for this element. Modelers should not change these values or assign new ones, but they may copy them to indicate an element's historic predecessor."/> <property> <code value="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10084"/> </property> </concept> </CodeSystem>