NLM logo

Unified Medical Language System (UMLS)

UMLS Vocabularies

HL7V3.0 (HL7 Version 3.0) - Metathesaurus Representation


This page lists UMLS Metathesaurus data elements and traces them back to the specific source data that populates them.

Skip to:
Atoms
Attributes
Definitions
Relationships
Mappings

VSAB:HL7V3.0_2021_12

Summary of Changes

None

Source Provided Files:

The HL7V3.0 source is provided in DEFN=UV=VO=3.0.0.coremif.txt. Elements in this file can be described by their path of xml tags starting from the root. In the xml path descriptions below, an XPath-like format is used to describe the origin of various items, but the top-level <vocabularyModel> path element is omitted for brevity.

Note that some HL7V3.0 elements, such as <conceptProperty>, use a "name, value" format instead of nested xml tags to represent properties, e.g., <conceptProperty name="status" value="retired"/> instead of <conceptProperty><status>retired</status></conceptProperty>. Such a "name, value" item is represented in the xml path descriptions below using the format "conceptProperty/@name=status".

Identifiers:

HL7V3.0 SAUI and SDUI identifiers are not assigned. There are several types of HL7V3.0 atoms that each get different assignments of CODE and SCUI identifiers, as follows:
Concept Type Origin (xml tag path under <vocabularyModel>)
BR CODE = bindingRealm/@name
SCUI = bindingRealm/@name
CDO CODE = conceptDomain/@name
SCUI = conceptDomain/@name
CPR CODE = codeSystem/releasedVersion/supportedConceptProperty/@propertyName
SCUI = codeSystem/releasedVersion/supportedConceptProperty/@propertyName
CR CODE = codeSystem/releasedVersion/supportedConceptRelationship/@name
SCUI = codeSystem/releasedVersion/supportedConceptRelationship/@name
CSY CODE = codeSystem/@name
SCUI = codeSystem/@codeSystemId
PT, NPT, OP, ONP CODE = codeSystem/releasedVersion/concept/code/@code
SCUI = codeSystem/releasedVersion/concept/conceptProperty/@name=internalId
VS CODE = valueSet/@id
SCUI = valueSet/@id

Atoms (MRCONSO):

Term Type Origin (xml tag path under <vocabularyModel>)
BR CODE = bindingRealm/@name
STR = bindingRealm/description
SCUI = bindingRealm/@name

CDO		 CODE = conceptDomain/@name
STR = conceptDomain/@name
SCUI = conceptDomain/@name
CPR CODE = codeSystem/releasedVersion/supportedConceptProperty/@propertyName
STR = codeSystem/releasedVersion/supportedConceptProperty/@propertyName
SCUI = codeSystem/releasedVersion/supportedConceptProperty/@propertyName

CR		 CODE = codeSystem/releasedVersion/supportedConceptRelationship/@name
STR = codeSystem/releasedVersion/supportedConceptRelationship/@name
SCUI = codeSystem/releasedVersion/supportedConceptRelationship/@name
CSY CODE = codeSystem/@name
STR = codeSystem/@title
SCUI = codeSystem/@codeSystemId
PT, NPT,
OP, ONP		 CODE = codeSystem/releasedVersion/concept/code/@code
STR = codeSystem/releasedVersion/concept/printName/@text
SCUI = codeSystem/releasedVersion/concept/conceptProperty/@name=internalId

Notes:
- Non-preferred term types (NPT or ONP) are used where codeSystem/releasedVersion/concept/printName/@preferredForLanguage="false"
- Obsolete term types (OP or ONP) are used where codeSystem/releasedVersion/concept/code/@status is "retired"
- Some retired concepts are defined with a code and an internalId but have no printName; these concepts are given STR = "Retired Code"
VS CODE = valueSet/@id
STR = valueSet/@name
SCUI = valueSet/@id

Attributes (MRSAT):

Note: ATNs HL7BR, HL7CST and HL7ED are attached to relationships, see below.
Attribute Name Concept type Origin (xml tag path under <vocabularyModel>)
HL7AI CSY codeSystem/releasedVersion/@hl7ApprovedIndicator
HL7AP VS valueSet/version/associatedConceptProperty
HL7AR root packageLocation/@artifact
HL7AT PT codeSystem/releasedVersion/concept/conceptProperty/@name=appliesTo
HL7CC CSY codeSystem/releasedVersion/@completeCodesIndicator
HL7CD PT codeSystem/releasedVersion/concept/conceptProperty/@name=conductible
HL7CI root packageLocation/@combinedId
HL7CP root header/legalese/@copyrightOwner
HL7CS PT codeSystem/releasedVersion/concept/code/@status [attached at atom level by CODE]
HL7CSC CDO conceptDomain/property/@name=ConceptualSpaceForClassCode
HL7CY root header/legalese/@copyrightYears
HL7DC PT codeSystem/releasedVersion/concept/conceptProperty/@name=isDocumentCharacteristic
HL7DI CDO conceptDomain/annotations/appInfo/deprecationInfo
HL7DI CSY codeSystem/annotations/appInfo/deprecationInfo
HL7DI PT codeSystem/releasedVersion/concept/annotations/appInfo/deprecationInfo
HL7DI VS valueSet/annotations/appInfo/deprecationInfo
HL7DK root @definitionKind
HL7HA PT codeSystem/releasedVersion/concept/conceptProperty/@name=howApplies
HL7ID PT codeSystem/releasedVersion/concept/conceptProperty/@name=internalId
HL7II VS valueSet/@isImmutable
HL7IM CPR codeSystem/releasedVersion/supportedConceptProperty/@isMandatoryIndicator
HL7IN CR codeSystem/releasedVersion/supportedConceptRelationship/@inverseName
HL7IR PT codeSystem/releasedVersion/concept/conceptProperty/@name=inverseRelationship
HL7IS PT codeSystem/releasedVersion/concept/@isSelectable
HL7LT CSY codeSystem/header/legalese/licenseTerms
HL7MI CSY codeSystem/releasedVersion/@hl7MaintainedIndicator
HL7MN root @name [i.e., vocabularyModel/@name]
HL7NA CR codeSystem/releasedVersion/supportedConceptRelationship/@isNavigable
HL7OA BR bindingRealm/@owningAffiliate
HL7OD PT codeSystem/releasedVersion/concept/conceptProperty/@name=OID
HL7PK root @packageKind
HL7PL PT codeSystem/releasedVersion/concept/printName/@preferredForLanguage [attached at atom level by name (STR)]
HL7PR root packageLocation/@root
HL7RA root header/renderingInformation/@application
HL7RD CSY codeSystem/releasedVersion/@releaseDate
HL7RF CR codeSystem/releasedVersion/supportedConceptRelationship/@reflexivity
HL7RG CSY codeSystem/header/responsibleGroup/@organizationName
HL7RK CR codeSystem/releasedVersion/supportedConceptRelationship/@relationshipKind
HL7RN root packageLocation/@realmNamespace
HL7RO PT codeSystem/releasedVersion/concept/conceptProperty/@name=responsibleOrganization
HL7RT root header/renderingInformation/@renderingTime
HL7SCS VS valueSet/version/supportedCodeSystem
HL7SL CSY codeSystem/releasedVersion/supportedLanguage
HL7SL VS valueSet/version/supportedLanguage
HL7SV root @schemaVersion
HL7SY CR codeSystem/releasedVersion/supportedConceptRelationship/@symmetry
HL7TI root @title
HL7TR CR codeSystem/releasedVersion/supportedConceptRelationship/@transitivity
HL7TY CPR codeSystem/releasedVersion/supportedConceptProperty/@type
HL7UN CDO conceptDomain/annotations/documentation/usageNotes/text
HL7UN PT codeSystem/releasedVersion/concept/annotations/documentation/usageNotes/text
HL7VC VS valueSet/version/content
HL7VD VS valueSet/version/@versionDate
HL7VE root packageLocation/@version
HL7XN root @xmlns

Definitions (MRDEF):

Definitions are created as follows:

Concept type Origin (xml tag path under <vocabularyModel>)
CDO conceptDomain/annotations/documentation/definition/text
CPR codeSystem/releasedVersion/supportedConceptProperty/description
CR codeSystem/releasedVersion/supportedConceptRelationship/description
CSY codeSystem/annotations/documentation/description/text
NPT, OP, PT codeSystem/releasedVersion/concept/annotations/documentation/definition/text
VS valueSet/annotations/documentation/description/text

Relationships (MRREL):

REL RELA
Inverse RELA		 Origin (xml tag path under <vocabularyModel>)
CHD
PAR		 Hierarchical relationships are created in 3 situations:
(1) Between each PT concept and the CSY concept it is embedded in,
(2) Among PT concepts as specified by codeSystem/releasedVersion/concept/conceptRelationship elements where @relationshipName is "Specializes", and
(3) Among CDO concepts as specified by conceptDomain/specializesDomain elements.
RO classifies_class_code
class_code_classified_by		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "ClassifiesClassCode"
RO component_of
has_component		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "ComponentOf"
RO context_binding_of
has_context_binding		 contextBinding (between the VS concept specified by @valueSet and the CDO concept specified by @conceptDomain)

Note: these relationships may have three attributes:
Attribute Name Origin (xml tag path under <vocabularyModel>)
HL7BR contextBinding/@bindingRealmName
HL7CST contextBinding/@codingStrength
HL7ED contextBinding/@effectiveDate
RO has_owning_affiliate
owning_affiliate_of		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "OwningAffiliate"
RO has_owning_section
owning_section_of		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "OwningSection"
RO has_owning_subsection
owning_subsection_of		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "OwningSubSection"
RO may_be_qualified_by
may_qualify		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "MayBeQualifiedBy"
RO smaller_than
larger_than		 codeSystem/releasedVersion/concept/conceptRelationship where @relationshipName is "SmallerThan"
RO supported_concept_property_in
has_supported_concept_property		 codeSystem/releasedVersion/supportedConceptProperty (to its codeSystem)
RO supported_concept_relationship_in
has_supported_concept_relationship		 codeSystem/releasedVersion/supportedConceptRelationship (to its codeSystem)

Mappings (MRMAP):

  

No mappings to external sources are provided for HL7V3.0.