Skip Navigation Bar
 

Unified Medical Language System® (UMLS®)

2012AA Health Level Seven Vocabulary Source Information




Skip to: Atoms, Attributes, Definitions, Relationships, Mappings

VSAB: HL7V3.0_2011_03

Summary of Changes

HL7V3.0_2011_03 includes the following new data types:

Term Types:
BR (binding realm)
CDO (concept domain)
CPR (concept property)
CR (concept relationship)
CSY (code system)
VS (value set)

RELAs:
classifies_class_code
component_of
context_binding_of
expanded_form_of
has_owning_affiliate
has_owning_section
has_owning_subsection
may_be_qualified_by
supported_concept_property_in
supported_concept_relationship_in

Attributes:
HL7AI
HL7AP
HL7AR
HL7AV
HL7BR
HL7CC
HL7CD
HL7CI
HL7CO
HL7CP
HL7CS
HL7CSC
HL7CST
HL7CY
HL7DC
HL7DH
HL7DI
HL7DK
HL7DV
HL7ED
HL7II
HL7IM
HL7IN
HL7IS
HL7LT
HL7MI
HL7MN
HL7NA
HL7NO
HL7OA
HL7PK
HL7PR
HL7PV
HL7RA
HL7RD
HL7RF
HL7RG
HL7RK
HL7RN
HL7RO
HL7RT
HL7SCS
HL7SL
HL7SQ
HL7SV
HL7SY
HL7TI
HL7TR
HL7TY
HL7VC
HL7VD
HL7VE
HL7VP
HL7XN

The following data types were deleted in HL7V3.0_2011_03:

RELAs:
mth_plain_text_form_of

Attributes:
HCDI
HCS
HDS

The following attributes were renamed for improved consistency.  This change resulted in new ATUI assignments for existing attributes:
HAT -> HL7AT
HHA -> HL7HA
HID -> HL7ID
HLIR -> HL7IR
HOD -> HL7OD
HOI -> HL7OI
HPL -> HL7PL

Source Provided Files:

The HL7V3.0 source is provided in an xml file called DEFN=UV=VO=1061-20100829.coremif.  Elements in this xml 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
CODE = codeSystem/releasedVersion/concept/code/@code
SCUI = codeSystem/releasedVersion/concept/conceptProperty/@name=internalId
VS CODE = valueSet/@id
SCUI = valueSet/@id

Atoms (MRCONSO):

  (return to top)
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
MTH_PT,
MTH_NPT
For atoms whose STR contains one or more non-ASCII UTF-8 characters, an MTH_* form is generated (with the same CODE and SCUI) in which these characters are converted to pure ASCII using the -f:q5 flow of the UMLS lvg (lexical variant generation) tool.
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):

Attributes are attached at the concept level except for HL7CS and HL7PL, which are attached at the atom level, as noted below:

  (return to top)
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
HL7AV CPR
codeSystem/releasedVersion/supportedConceptProperty/@applyToValueSetsIndicator
HL7CC CSY
codeSystem/releasedVersion/@completeCodesIndicator
HL7CD PT
codeSystem/releasedVersion/concept/conceptProperty/@name=conductible
HL7CI root
packageLocation/@combinedId
HL7CO CSY
codeSystem/header/contributor
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
HL7DH CPR
codeSystem/releasedVersion/supportedConceptProperty/@defaultHandlingCode
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
HL7DV CPR
codeSystem/releasedVersion/supportedConceptProperty/@defaultValue
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
HL7NO
CSY
codeSystem/header/legalese/notation
HL7OA
BR
bindingRealm/@owningAffiliate
HL7OD
PT
codeSystem/releasedVersion/concept/conceptProperty/@name=OID
HL7OI
CDO
conceptDomain/annotations/appInfo/openIssue/text
HL7OI PT
codeSystem/releasedVersion/concept/annotations/appInfo/openIssue/text
HL7PK root
@packageKind
HL7PL PT
codeSystem/releasedVersion/concept/printName/@preferredForLanguage [attached at atom level by name (STR)]
HL7PR
root
packageLocation/@root
HL7PV
CSY
codeSystem/releasedVersion/@publisherVersionId
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
HL7SQ PT
codeSystem/releasedVersion/concept/conceptProperty/@name=conceptStatusQualifier
HL7SV root
@schemaVersion
HL7SY CR
codeSystem/releasedVersion/supportedConceptRelationship/@symmetry
HL7TI
root
@title
HL7TR CR
codeSystem/releasedVersion/supportedConceptRelationship/@transitivity
HL7TY CPR
codeSystem/releasedVersion/supportedConceptProperty/@type
HL7VC
VS
valueSet/version/content
HL7VD VS
valueSet/version/@versionDate
HL7VE root
packageLocation/@version
HL7VP CSY
codeSystem/header/legalese/versioningPolicy
HL7XN
root
@xmlns

Definitions (MRDEF):

  (return to top)

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
PT
codeSystem/releasedVersion/concept/annotations/documentation/definition/text
VS
valueSet/annotations/documentation/description/text



Relationships (MRREL):

  (return to top)
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):

  (return to top)

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