diff --git a/input/pagecontent/LOINC.xml b/input/pagecontent/LOINC.xml index 0c07629de..56d5b2f60 100644 --- a/input/pagecontent/LOINC.xml +++ b/input/pagecontent/LOINC.xml @@ -1,21 +1,25 @@
This page describes how to use LOINC with HL7 Standards.
- -Source | LOINC is made available by the Regenstrief Institute at http://loinc.org |
System | The URI http://loinc.org identifies LOINC codes |
Version | Where a version is used, it should be the standard LOINC version e.g. 2.48 |
Code | The LOINC Code Identifier e.g. 21176-3. LOINC codes are not case sensitive. In addition, LOINC part codes and LOINC answer string ids can be used where appropriate |
Display | Use either the SHORTNAME or LONG_COMMON_NAME field for the display |
Inactive | Codes with Property STATUS = DEPRECATED are considered inactive for use in ValueSet.compose.inactive |
Subsumption | LOINC defines the Multi-Axial Hierarchy, which is the basis for subsumption logic in LOINC |
Filter Properties | Several properties are defined as described below |
Source | LOINC is made available by the Regenstrief Institute at http://loinc.org |
System | The URI http://loinc.org identifies LOINC codes |
Version | Where a version is used, it should be the standard LOINC version e.g. 2.48 |
Code | The LOINC Code Identifier e.g. 21176-3. LOINC codes are not case sensitive. In addition, LOINC part codes and LOINC answer string ids can be used where appropriate |
Display | Use either the SHORTNAME or LONG_COMMON_NAME field for the display |
Inactive | Codes with Property STATUS = DEPRECATED are considered inactive for use in ValueSet.compose.inactive |
Subsumption | LOINC defines the Component Hierarchy and Document Ontology, which are the bases for subsumption logic in LOINC |
Filter Properties | Several properties are defined as described below |
+This page is maintained by HL7 in association with the LOINC team at Regenstrief and is the authoritative source for how +LOINC is used with FHIR. +
@@ -32,17 +36,28 @@ LOINC® is available at no cost under the license atRegenstrief Institute provides access to LOINC's terminology content through the HL7® FHIR® API. See the LOINC FHIR Terminology Server page for details.
++Note that the FHIR server at fhir.loinc.org is a work in progress; where the service does not agree with the content on this page, implementers should consider +this as a problem with the LOINC service that is planned to be reconciled with this page. +
For comparison purposes, LOINC codes, displays, and property values are not case sensitive, though implementers SHOULD maintain the correct case when using LOINC codes and property values.
++LOINC codes, property names, filter names and designation types are considered case sensitive. For comparison purposes (e.g. when executing a filter), +LOINC displays, and property values are not case sensitive, though implementers SHOULD maintain the correct case when using LOINC codes and property values. +
As described in the LOINC Manual section 10.2, LOINC Parts are a coded representation of a value for a dimension used to specify a LOINC Term which are assigned a non-semantic identifier with a "LP" prefix and a mod-10 check digit. Following the LOINC license, these part codes may be used in the following ways:
+As described in the LOINC Manual section 9.3, +LOINC Parts are a coded representation of a value for a dimension used to specify a LOINC Term which are assigned a non-semantic identifier +with a "LP" prefix and a mod-10 check digit. Following the LOINC license, these part codes may be used in the following ways:
LOINC also allocates Answer List and Answer String Ids for use in various forms and questionnaires. LOINC Answer String IDs are also valid LOINC codes:
+As described in the LOINC Manual section 9.2, +LOINC also defines Answer Lists for use in various forms and questionnaires. Both the list of Answers and the individual answers have String Ids. +LOINC Answer String IDs are also valid LOINC codes:
<coding> <system value="http://loinc.org"/> @@ -60,7 +77,7 @@ LOINC® is available at no cost under the license at below for how to use these. +LOINC Answer List Ids are associated with implicit value set identifiers. See below for how to use these.
@@ -70,145 +87,242 @@ LOINC® is available at no cost under the license atLOINC Properties
-In addition to the standard properties, the following LOINC table fields are defined as code system properties when using LOINC in FHIR:
+The following code system properties are defined when using LOINC in FHIR. These properties are found in $lookup responses, and can also be +used in filters.
+
STATUS | string | Status of the term | |
COMPONENT | code | First major axis-component or analyte: Analyte Name, Analyte sub-class, Challenge | |
PROPERTY | code | Second major axis-property observed: Kind of Property (also called kind of quantity) | |
TIME_ASPCT | code | Third major axis-timing of the measurement: Time Aspect (Point or moment in time vs. time interval) | |
SYSTEM | code | Fourth major axis-type of specimen or system: System (Sample) Type | |
SCALE_TYP | code | Fifth major axis-scale of measurement: Type of Scale | |
METHOD_TYP | code | Sixth major axis-method of measurement: Type of Method | |
CLASS | string | An arbitrary classification of the terms for grouping related observations together | |
CONSUMER_NAME | string | An experimental (beta) consumer friendly name for this item. The intent is to provide a test name that health care consumers will recognize; it will be similar to the names that might appear on a lab report | |
CLASSTYPE | string | 1=Laboratory class; 2=Clinical class; 3=Claims attachments; 4=Surveys | |
ORDER_OBS | string | Provides users with an idea of the intended use of the term by categorizing it as an order only, observation only, or both | |
DOCUMENT_SECTION | string | Classification of whether this LOINC code can be used a full document, a section of a document, or both | |
Code | Type | Description | Source in Distribution |
parent | code | A parent code in the Component Hierarchy by System | from IMMEDIATE_PARENT in ComponentHierarchyBySystem |
child | code | A child code in the Component Hierarchy by System | inferred from IMMEDIATE_PARENT in ComponentHierarchyBySystem |
COMPONENT | code | First major axis-component or analyte: Analyte Name, Analyte sub-class, Challenge | PartTypeName = "COMPONENT" in LoincPartLink_Primary |
PROPERTY | code | Second major axis-property observed: Kind of Property (also called kind of quantity) | PartTypeName = "PROPERTY" in LoincPartLink_Primary |
TIME_ASPCT | code | Third major axis-timing of the measurement: Time Aspect (Point or moment in time vs. time interval) | PartTypeName = "TIME" in LoincPartLink_Primary |
SYSTEM | code | Fourth major axis-type of specimen or system: System (Sample) Type | PartTypeName = "SYSTEM" in LoincPartLink_Primary |
SCALE_TYP | code | Fifth major axis-scale of measurement: Type of Scale | PartTypeName = "SCALE" in LoincPartLink_Primary |
METHOD_TYP | code | Sixth major axis-method of measurement: Type of Method | PartTypeName = "METHOD" in LoincPartLink_Primary |
CLASS | code | An arbitrary classification of terms for grouping related observations together | "CLASS" in LOINC.csv, with "class." prepended |
VersionLastChanged | string | The LOINC version number in which the record has last changed. For new records, this field contains the same value as the VersionFirstReleased property. | VersionLastChanged in LOINC.CSV |
CHNG_TYPE | string | DEL = delete (deprecate); ADD = add; PANEL = addition or removal of child elements or change in the conditionality of child elements in the panel or in sub-panels contained by the panel; NAM = change to Analyte/Component (field #2); MAJ = change to name field other than #2 (#3 - #7); MIN = change to field other than name; UND = undelete | CHNG_TYPE in LOINC.csv |
DefinitionDescription | string | Narrative text that describes the LOINC term taken as a whole (i.e., taking all of the parts of the term together) or relays information specific to the term, such as the context in which the term was requested or its clinical utility. | DefinitionDescription in LOINC.csv |
STATUS | string | Status of the term. Within LOINC, codes with STATUS=DEPRECATED are considered inactive. Current values: ACTIVE, TRIAL, DISCOURAGED, and DEPRECATED | STATUS in LOINC.csv, Status in PART.csv |
CLASSTYPE | string | 1=Laboratory class; 2=Clinical class; 3=Claims attachments; 4=Surveys | CLASSTYPE in LOINC.csv |
FORMULA | string | Contains the formula in human readable form, for calculating the value of any measure that is based on an algebraic or other formula except those for which the component expresses the formula. So Sodium/creatinine does not need a formula, but Free T3 index does. | FORMULA in LOINC.csv |
EXMPL_ANSWERS | string | For some tests and measurements, we have supplied examples of valid answers, such as '1:64', 'negative @ 1:16', or '55'. | EXMPL_ANSWERS in LOINC.csv |
SURVEY_QUEST_TEXT | string | Verbatim question from the survey instrument | SURVEY_QUEST_TEXT in LOINC.csv |
SURVEY_QUEST_SRC | string | Exact name of the survey instrument and the item/question number | SURVEY_QUEST_SRC in LOINC.csv |
UNITSREQUIRED | string | Y/N field that indicates that units are required when this LOINC is included as an OBX segment in a HIPAA attachment | UNITSREQUIRED in LOINC.csv |
ORDER_OBS | string | Provides users with an idea of the intended use of the term by categorizing it as an order only, observation only, or both | ORDER_OBS in LOINC.csv |
HL7_FIELD_SUBFIELD_ID | string | A value in this field means that the content should be delivered in the named field/subfield of the HL7 message. When NULL, the data for this data element should be sent in an OBX segment with this LOINC code stored in OBX-3 and with the value in the OBX-5. | HL7_FIELD_SUBFIELD_ID in LOINC.csv |
EXTERNAL_COPYRIGHT_NOTICE | string | External copyright holders copyright notice for this LOINC code | EXTERNAL_COPYRIGHT_NOTICE in LOINC.csv |
EXAMPLE_UNITS | string | This field is populated with a combination of submitters units and units that people have sent us. Its purpose is to show users representative, but not necessarily recommended, units in which data could be sent for this term. | EXAMPLE_UNITS in LOINC.csv |
EXAMPLE_UCUM_UNITS | string | The Unified Code for Units of Measure (UCUM) is a code system intended to include all units of measures being contemporarily used in international science, engineering, and business. (www.unitsofmeasure.org) This field contains example units of measures for this term expressed as UCUM units. | EXAMPLE_UCUM_UNITS in LOINC.csv |
STATUS_REASON | string | Classification of the reason for concept status. This field will be Null for ACTIVE concepts | STATUS_REASON in LOINC.csv |
STATUS_TEXT | string | Explanation of concept status in narrative text. This field will be Null for ACTIVE concepts, and optionally populated for terms in other status. | STATUS_TEXT in LOINC.csv |
CHANGE_REASON_PUBLIC | string | Detailed explanation about special changes to the term over time. | CHANGE_REASON_PUBLIC in LOINC.csv |
COMMON_TEST_RANK | string | Ranking of approximately 2000 common tests performed by laboratories in USA. | COMMON_TEST_RANK in LOINC.csv |
COMMON_ORDER_RANK | string | Ranking of approximately 300 common orders performed by laboratories in USA. | COMMON_ORDER_RANK in LOINC.csv |
HL7_ATTACHMENT_STRUCTURE | string | This property is populated in collaboration with the HL7 Payer-Provider Exchange (PIE) Work Group (previously called Attachments Work Group) as described in the HL7 Attachment Specification: Supplement to Consolidated CDA Templated Guide. | HL7_ATTACHMENT_STRUCTURE in LOINC.csv |
EXTERNAL_COPYRIGHT_LINK | string | For terms that have a third party copyright, this field is populated with the COPYRIGHT_ID from the Source Organization table (see below). It links an external copyright statement to a term. | EXTERNAL_COPYRIGHT_LINK in LOINC.csv |
PanelType | string | For LOINC terms that are panels, this attribute classifies them as a 'Convenience group', 'Organizer', or 'Panel' | PanelType in LOINC.csv |
AskAtOrderEntry | string | A multi-valued, semicolon delimited list of LOINC codes that represent optional Ask at Order Entry (AOE) observations for a clinical observation or laboratory test. A LOINC term in this field may represent a single AOE observation or a panel containing several AOE observations. | AskAtOrderEntry in LOINC.csv |
AssociatedObservations | string | A multi-valued, semicolon delimited list of LOINC codes that represent optional associated observation(s) for a clinical observation or laboratory test. A LOINC term in this field may represent a single associated observation or panel containing several associated observations. | AssociatedObservations in LOINC.csv |
VersionFirstReleased | string | This is the LOINC version number in which this LOINC term was first published. | VersionFirstReleased in LOINC.csv in LOINC.csv |
ValidHL7AttachmentRequest | string | A value of Y in this field indicates that this LOINC code can be sent by a payer as part of an HL7 Attachment request for additional information. | ValidHL7AttachmentRequest in LOINC.csv |
answer-list | code | An answer list associated with this LOINC code (if there are matching answer lists defined). | inferred from LoincAnswerListLink.csv |
MAP_TO | code | A replacement term that is to be used in place of the deprecated or discouraged term. | ?? |
analyte | code | First sub-part of the Component, i.e., the part of the Component before the first carat | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
analyte-core | code | The primary part of the analyte without the suffix | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
analyte-suffix | code | The suffix part of the analyte, if present, e.g., Ab or DNA | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary. Or PartTypeName = "SUFFIX" in LoincPartLink_Primary? |
analyte-numerator | code | The numerator part of the analyte, i.e., everything before the slash in analytes that contain a divisor | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
analyte-divisor | code | The divisor part of the analyte, if present, i.e., after the slash and before the first carat | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary. Or PartTypeName = "DIVISORS" in LoincPartLink_Primary? |
analyte-divisor-suffix | code | The suffix part of the divisor, if present | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
challenge | code | Second sub-part of the Component, i.e., after the first carat | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
adjustment | code | Third sub-part of the Component, i.e., after the second carat | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
count | code | Fourth sub-part of the Component, i.e., after the third carat | derived from PartTypeName = "COMPONENT" in LoincPartLink_Primary |
time-core | code | The primary part of the Time | derived from PartTypeName = "TIME" in LoincPartLink_Primary |
time-modifier | code | The modifier of the Time value, such as mean or max | derived from PartTypeName = "TIME" in LoincPartLink_Primary |
system-core | code | The primary part of the System, i.e., without the super system | derived from PartTypeName = "SYSTEM" in LoincPartLink_Primary |
super-system | code | The super system part of the System, if present. The super system represents the source of the specimen when the source is someone or something other than the patient whose chart the result will be stored in. For example, fetus is the super system for measurements done on obstetric ultrasounds, because the fetus is being measured and that measurement is being recorded in the patient's (mother's) chart. | derived from PartTypeName = "SYSTEM" in LoincPartLink_Primary |
analyte-gene | code | The specific gene represented in the analyte | PartTypeName = "GENE" in LoincPartLink_Primary |
category | code | A single LOINC term can be assigned one or more categories based on both programmatic and manual tagging. Category properties also utilize LOINC Class Parts. | ?? |
search | code | Synonyms, fragments, and other Parts that are linked to a term to enable more encompassing search results. | ?? |
rad-modality-modality-type | code | Modality is used to represent the device used to acquire imaging information. | PartTypeName = "Rad.Modality.Modality Type" in LoincPartLink_Primary |
rad-modality-modality-subtype | code | Modality subtype may be optionally included to signify a particularly common or evocative configuration of the modality. | PartTypeName = "Rad.Modality.Modality Subtype" in LoincPartLink_Primary |
rad-anatomic-location-region-imaged | code | The Anatomic Location Region Imaged attribute is used in two ways: as a coarse-grained descriptor of the area imaged and a grouper for finding related imaging exams; or, it is used just as a grouper. | PartTypeName = "Rad.Anatomic Location.Region Imaged" in LoincPartLink_Primary |
rad-anatomic-location-imaging-focus | code | The Anatomic Location Imaging Focus is a more fine-grained descriptor of the specific target structure of an imaging exam. In many areas, the focus should be a specific organ. | PartTypeName = "Rad.Anatomic Location.Imaging Focus" in LoincPartLink_Primary |
rad-anatomic-location-laterality-presence | code | Radiology Exams that require laterality to be specified in order to be performed are signified with an Anatomic Location Laterality Presence attribute set to 'True' | PartTypeName = "Rad.Anatomic Location.Laterality.Presence" in LoincPartLink_Primary |
rad-anatomic-location-laterality | code | Radiology exam Laterality is specified as one of: Left, Right, Bilateral, Unilateral, Unspecified | PartTypeName = "Rad.Anatomic Location.Laterality" in LoincPartLink_Primary |
rad-view-aggregation | code | Aggregation describes the extent of the imaging performed, whether in quantitative terms (e.g., '3 or more views') or subjective terms (e.g., 'complete'). | PartTypeName = "Rad.View.Aggregation" in LoincPartLink_Primary |
rad-view-view-type | code | View type names specific views, such as 'lateral' or 'AP'. | PartTypeName = "Rad.View.View Type" in LoincPartLink_Primary |
rad-maneuver-maneuver-type | code | Maneuver type indicates an action taken with the goal of elucidating or testing a dynamic aspect of the anatomy. | PartTypeName = "Rad.Maneuver.Maneuver Type" in LoincPartLink_Primary |
rad-timing | code | The Timing/Existence property used in conjunction with pharmaceutical and maneuver properties. It specifies whether or not the imaging occurs in the presence of the administered pharmaceutical or a maneuver designed to test some dynamic aspect of anatomy or physiology . | PartTypeName = "Rad.Timing" in LoincPartLink_Primary |
rad-pharmaceutical-substance-given | code | The Pharmaceutical Substance Given specifies administered contrast agents, radiopharmaceuticals, medications, or other clinically important agents and challenges during the imaging procedure. | PartTypeName = "Rad.Pharmaceutical.Substance Given" in LoincPartLink_Primary |
rad-pharmaceutical-route | code | Route specifies the route of administration of the pharmaceutical. | PartTypeName = "Rad.Pharmaceutical.Route" in LoincPartLink_Primary |
rad-reason-for-exam | code | Reason for exam is used to describe a clinical indication or a purpose for the study. | PartTypeName = "Rad.Reason for Exam" in LoincPartLink_Primary |
rad-guidance-for-presence | code | Guidance for.Presence indicates when a procedure is guided by imaging. | PartTypeName = "Rad.Guidance for.Presence" in LoincPartLink_Primary |
rad-guidance-for-approach | code | Guidance for.Approach refers to the primary route of access used, such as percutaneous, transcatheter, or transhepatic. | PartTypeName = "Rad.Guidance for.Approach" in LoincPartLink_Primary |
rad-guidance-for-action | code | Guidance for.Action indicates the intervention performed, such as biopsy, aspiration, or ablation. | PartTypeName = "Rad.Guidance for.Action" in LoincPartLink_Primary |
rad-guidance-for-object | code | Guidance for.Object specifies the target of the action, such as mass, abscess or cyst. | PartTypeName = "Rad.Guidance for.Object" in LoincPartLink_Primary |
rad-subject | code | Subject is intended for use when there is a need to distinguish between the patient associated with an imaging study, and the target of the study. | PartTypeName = "Rad.Subject" in LoincPartLink_Primary |
document-kind | code | Characterizes the general structure of the document at a macro level. | PartTypeName = "Document.Kind" in LoincPartLink_Primary |
document-role | code | Characterizes the training or professional level of the author of the document, but does not break down to specialty or subspecialty. | PartTypeName = "Document.Role" in LoincPartLink_Primary |
document-setting | code | Setting is a modest extension of CMS’s coarse definition of care settings, such as outpatient, hospital, etc. Setting is not equivalent to location, which typically has more locally defined meanings. | PartTypeName = "Document.Setting" in LoincPartLink_Primary |
document-subject-matter-domain | code | Characterizes the clinical domain that is the subject of the document. For example, Internal Medicine, Neurology, Physical Therapy, etc. | PartTypeName = "Document.SubjectMatterDomain" in LoincPartLink_Primary |
document-type-of-service | code | Characterizes the kind of service or activity provided to/for the patient (or other subject of the service) that is described in the document. | PartTypeName = "Document.TypeOfService" in LoincPartLink_Primary |
answers-for | code | A LOINC Code for which this answer list is used. | inferred from LoincAnswerListLink.csv |
answer | code | An answer in this answer-list. Note that order matters for this property | inferred from AnswerList.csv |
answer-list | code | An answer list that this answer is part of | inferred from AnswerList.csv |
Note that when a $lookup operation is performed on a LOINC code, servers SHALL return the version being used (see above) in the version
property. Other properties are at the discretion of the server and the client.
+Notes about this table: +
+version
property. Other properties are at the discretion of the server and the client.+In addition, LOINC defines the following designation types: +
+ +Code | Type | Description | Source in Distribution |
FullySpecifiedName | code | Calculated from the names of the part codes for the six axes: COMPONENT:PROPERTY:TIME_ASPCT:SYSTEM:SCALE_TYP:METHOD_TYP | calculated |
CONSUMER_NAME | string | An experimental (beta) consumer friendly name for this item. The intent is to provide a test name that health care consumers will recognize. | from ConsumerName.csv |
RELATEDNAMES2 | string | This designation was introduced in version 2.05. It contains synonyms for each of the parts of the fully specified LOINC name (component, property, time, system, scale, method). | RELATEDNAMES2 in LOINC.csv |
SHORTNAME | string | Introduced in version 2.07, this field contains the short form of the LOINC name and is created via a table-driven algorithmic process. The short name often includes abbreviations and acronyms. | SHORTNAME in LOINC.csv |
LONG_COMMON_NAME | string | This designation contains the LOINC name in a more readable format than the fully specified name. The long common names have been created via a tabledriven algorithmic process. Most abbreviations and acronyms that are used in the LOINC database have been fully spelled out in English. | LONG_COMMON_NAME in LOINC.csv |
DisplayName | string | A name that is more 'clinician-friendly' compared to the current LOINC Short Name, Long Common Name, and Fully Specified Name. It is created algorithmically from the manually crafted display text for each Part and is generally more concise than the Long Common Name. | DisplayName in LOINC.csv |
+Notes about this table: +
+This section documents the property filters that can be used with the LOINC code system in value set composition statements.
+