NLM logo

HL7V3.0 (HL7 Version 3.0) - Source Representation



Summary of Changes:

None.


Source-Provided Files: Summary

  

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".


Source-Provided Files: Details

  

The following is a list of elements (xml tag paths) available in HL7V3.0:

xml tag path (under top-level <vocabularyModel> tag) Representation
@definitionKind MRSAT.ATN="HL7DK" for the HL7V3.0 root concept
@name [i.e., vocabularyModel/@name] MRSAT.ATN="HL7MN" for the HL7V3.0 root concept
@packageKind MRSAT.ATN="HL7PK" for the HL7V3.0 root concept
@schemaVersion MRSAT.ATN="HL7SV" for the HL7V3.0 root concept
@title MRSAT.ATN="HL7TI" for the HL7V3.0 root concept
@xmlns MRSAT.ATN="HL7XN" for the HL7V3.0 root concept
bindingRealm/@owningAffiliate MRSAT.ATN="HL7OA" for the bindingRealm concept
bindingRealm/description MRCONSO.TTY="BR", CODE=SCUI=bindingRealm/@name
codeSystem/@title MRCONSO.TTY="CSY", CODE=codeSystem/@name,
SCUI=codeSystem/@codeSystemId
codeSystem/annotations/appInfo/deprecationInfo MRSAT.ATN="HL7DI" for the codeSystem concept
codeSystem/annotations/documentation/description/text MRDEF.DEF for the codeSystem concept
codeSystem/header/legalese/licenseTerms MRSAT.ATN="HL7LT" for the codeSystem concept
codeSystem/header/responsibleGroup/@organizationName MRSAT.ATN="HL7RG" for the codeSystem concept
codeSystem/releasedVersion/@completeCodesIndicator MRSAT.ATN="HL7CC" for the codeSystem concept
codeSystem/releasedVersion/@hl7ApprovedIndicator MRSAT.ATN="HL7AI" for the codeSystem concept
codeSystem/releasedVersion/@hl7MaintainedIndicator MRSAT.ATN="HL7MI" for the codeSystem concept
codeSystem/releasedVersion/@releaseDate MRSAT.ATN="HL7RD" for the codeSystem concept
codeSystem/releasedVersion/concept/@isSelectable MRSAT.ATN="HL7IS" for the concept
codeSystem/releasedVersion/concept/annotations/appInfo/deprecationInfo MRSAT.ATN="HL7DI" for the concept
codeSystem/releasedVersion/concept/annotations/documentation/definition/text MRDEF.DEF for the concept
codeSystem/releasedVersion/concept/annotations/documentation/usageNotes/text MRSAT.ATN="HL7UN" for the concept
codeSystem/releasedVersion/concept/code/@status MRSAT.ATN="HL7CS" for the concept [attached at atom level by CODE]
codeSystem/releasedVersion/concept/conceptProperty/@name=appliesTo MRSAT.ATN="HL7AT" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=conductible MRSAT.ATN="HL7CD" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=howApplies MRSAT.ATN="HL7HA" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=internalId MRSAT.ATN="HL7ID" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=inverseRelationship MRSAT.ATN="HL7IR" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=isDocumentCharacteristic MRSAT.ATN="HL7DC" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=OID MRSAT.ATN="HL7OD" for the concept
codeSystem/releasedVersion/concept/conceptProperty/@name=responsibleOrganization MRSAT.ATN="HL7RO" for the concept
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "ClassifiesClassCode"
MRREL.REL="RO", RELA="classifies_class_code"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "ComponentOf"
MRREL.REL="RO", RELA="component_of"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "MayBeQualifiedBy"
MRREL.REL="RO", RELA="may_be_qualified_by"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "OwningAffiliate"
MRREL.REL="RO", RELA="has_owning_affiliate"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "OwningSection"
MRREL.REL="RO", RELA="has_owning_section"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "OwningSubSection"
MRREL.REL="RO", RELA="has_owning_subsection"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "SmallerThan"
MRREL.REL="RO", RELA="smaller_than"
codeSystem/releasedVersion/concept/conceptRelationship
where @relationshipName is "Specializes"
Hierarchical relationship under the concept specified by
conceptRelationship/@targetConcept
codeSystem/releasedVersion/concept/printName/@preferredForLanguage
MRSAT.ATN="HL7PL" for the concept [attached at atom level by name (STR)]
codeSystem/releasedVersion/concept/printName/@text MRCONSO.TTY="PT", "NPT", "OP", or "ONP", CODE=concept/code/@code,
SCUI=concept/conceptProperty/@name=internalId

Notes:
- Each such concept is given a hierarchical relationship under the codeSystem
(TTY="CSY") concept within which it is embedded
- 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"
codeSystem/releasedVersion/supportedConceptProperty
MRREL.REL="RO", RELA="supported_concept_property_in"( to its
codeSystem)
codeSystem/releasedVersion/supportedConceptProperty/@applyToValueSetsIndicator MRSAT.ATN="HL7AV" for the supportedConceptProperty concept
codeSystem/releasedVersion/supportedConceptProperty/@isMandatoryIndicator MRSAT.ATN="HL7IM" for the supportedConceptProperty concept
codeSystem/releasedVersion/supportedConceptProperty/@propertyName MRCONSO.TTY="CPR", CODE=SCUI=supportedConceptProperty/@propertyName
codeSystem/releasedVersion/supportedConceptProperty/@type MRSAT.ATN="HL7TY" for the supportedConceptProperty concept
codeSystem/releasedVersion/supportedConceptProperty/description MRDEF.DEF for the supportedConceptProperty concept
codeSystem/releasedVersion/supportedConceptRelationship
MRREL.REL="RO", RELA="supported_concept_relationship_in" (to its
codeSystem)
codeSystem/releasedVersion/supportedConceptRelationship/@inverseName MRSAT.ATN="HL7IN" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/@isNavigable MRSAT.ATN="HL7NA" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/@name MRCONSO.TTY="CR", CODE=SCUI=supportedConceptRelationship/@name
codeSystem/releasedVersion/supportedConceptRelationship/@reflexivity MRSAT.ATN="HL7RF" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/@relationshipKind MRSAT.ATN="HL7RK" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/@symmetry MRSAT.ATN="HL7SY" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/@transitivity MRSAT.ATN="HL7TR" for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedConceptRelationship/description MRDEF.DEF for the supportedConceptRelationship concept
codeSystem/releasedVersion/supportedLanguage MRSAT.ATN="HL7SL" for the codeSystem concept
conceptDomain/@name MRCONSO.TTY="CDO", CODE=SCUI=conceptDomain/@name
conceptDomain/annotations/appInfo/deprecationInfo MRSAT.ATN="HL7DI" for the conceptDomain concept
conceptDomain/annotations/documentation/definition/text MRDEF.DEF for the conceptDomain concept
conceptDomain/annotations/documentation/usageNotes/text MRSAT.ATN="HL7UN" for the conceptDomain concept
conceptDomain/property/@name=ConceptualSpaceForClassCode MRSAT.ATN="HL7CSC" for the conceptDomain concept
conceptDomain/specializesDomain Hierarchical relationship under the concept specified by
conceptDomain/@name
contextBinding MRREL.REL="RO", RELA="context_binding_of" (between the VS concept
specified by contextBinding/@valueSet and the CDO concept specified by contextBinding/@conceptDomain)
contextBinding/@bindingRealmName MRSAT.ATN="HL7BR" for the contextBinding relationship
contextBinding/@codingStrength MRSAT.ATN="HL7CST" for the contextBinding relationship
contextBinding/@effectiveDate MRSAT.ATN="HL7ED" for the contextBinding relationship
header/legalese/@copyrightOwner MRSAT.ATN="HL7CP" for the HL7V3.0 root concept
header/legalese/@copyrightYears MRSAT.ATN="HL7CY" for the HL7V3.0 root concept
header/renderingInformation/@application MRSAT.ATN="HL7RA" for the HL7V3.0 root concept
header/renderingInformation/@renderingTime MRSAT.ATN="HL7RT" for the HL7V3.0 root concept
packageLocation/@artifact MRSAT.ATN="HL7AR" for the HL7V3.0 root concept
packageLocation/@combinedId MRSAT.ATN="HL7CI" for the HL7V3.0 root concept
packageLocation/@realmNamespace MRSAT.ATN="HL7RN" for the HL7V3.0 root concept
packageLocation/@root MRSAT.ATN="HL7PR" for the HL7V3.0 root concept
packageLocation/@version MRSAT.ATN="HL7VE" for the HL7V3.0 root concept
valueSet/@isImmutable MRSAT.ATN="HL7II" for the valueSet concept
valueSet/@name MRCONSO.TTY="VS", CODE=SCUI=valueSet/@id
valueSet/annotations/appInfo/deprecationInfo MRSAT.ATN="HL7DI" for the valueSet concept
valueSet/annotations/documentation/description/text MRDEF.DEF for the valueSet concept
valueSet/version/@versionDate MRSAT.ATN="HL7VD" for the valueSet concept
valueSet/version/associatedConceptProperty MRSAT.ATN="HL7AP" for the valueSet concept
valueSet/version/content MRSAT.ATN="HL7VC" for the valueSet concept
valueSet/version/supportedCodeSystem MRSAT.ATN="HL7SCS" for the valueSet concept
valueSet/version/supportedLanguage MRSAT.ATN="HL7SL" for the valueSet concept