[go: up one dir, main page]

HL7 Terminology (THO)
6.1.0 - Publication International flag

This page is part of the HL7 Terminology (v6.1.0: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Using RxNorm with HL7 Standards

This page describes how to use RxNorm with HL7 Standards.

Using RxNorm with FHIR R5

Summary

SourceRxNorm is made available by the US National Library of Medicine at http://www.nlm.nih.gov/research/umls/rxnorm
SystemThe URI http://www.nlm.nih.gov/research/umls/rxnorm identifies the RxNorm code system
VersionWhere a version is used, it should be the date of release, encoded as in the download files, e.g. "07092014"
CodeThe code value for an RxNorm code is a Concept Identifier (CUI), and only CUIs for which there is an SAB=RXNORM
DisplayThe string description for the CUI that is associated with the source RXNORM. For further information, see below
InactiveTodo: Describe how it is determined which concepts are inactive
SubsumptionNo Subsumption relationships are defined by RxNorm
Filter PropertiesSeveral properties are defined as described below

RxNorm MySQL Database

The RxNorm scripts are able to populate a MySQL database that contains the data from RxNorm. This page provides SQL statements that describe how to implement the features of the RxNorm This page provides SQL statements that describe how to implement the features of the RxNorm terminology correctly against this database. These are provided for implementer convenience, and do not imply that any particular approach is required to be used in implementations.

Correct RxNorm Display

The correct display for a CUI is the string description associated with the source RXNORM. Given the RxNorm MySQL database, the correct display for a CUI can generally be determined by the example SQL below that finds the display for two of the available term types:

 Select STR from rxnconso where RXCUI = :code and SAB = 'RXNORM' and TTY in ('SCD', 'SBD')

Display values are not case sensitive, though case SHOULD be preserved.

Copyright/License Issues

Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.

RxNorm Filter Properties

This section documents the property filters that can be used with the RxNorm code system in value set composition statements.

The base SQL statement for returning a list of CUIs that conform to these filters is:

  Select RXCUI from rxnconso where SAB = 'RXNORM' and TTY <> 'SY'
Semantic Type
DescriptionAllows for the selection of a set of CUIs based on their Semantic Type
Property NameSTY
Operations Allowed= / in
Values Allowed[column:]value
CommentsIf no column is specified, the default column is TUI
SQL
and RXCUI in (select RXCUI from rxnsty where [:column] = :value)
Source
DescriptionAllows for the selection of a set of concepts that have mappings to a particular RxNorm concept
Property NameSAB
Operations Allowed= / in
Values AllowedValues from RxNorm SAB table (e.g. select RSAB from rxnsab)
SQL
and RXCUI in (select RXCUI from rxnconso where SAB = :value)
Term Type
DescriptionAllows for the selection of a concept based on its designated type
Property NameTTY
Operations Allowed= / in
Values AllowedTTY values from the RxNorm Concept table (e.g. select distinct TTY from rxnconso)
SQL
and TTY = :value
Relationship
DescriptionAllows for the selection of a concept based on its relationships
Property Name[REL]
Operations Allowed= / in
Values AllowedCUI:[RXCUI] or AUI:[RXAUI] must be a valid CUI or AUI. Note that a CUI does not need to have an SAB=RXNORM entry to be used here
Comments[REL] (:rel) is one of SY, SIB, RN, PAR, CHD, RB or RO
SQL for CUI: 
and (RXCUI in (select RXCUI from rxnconso where RXCUI in (select RXCUI1 from rxnrel where REL = :rel and RXCUI2 = :value))
for AUI: 
and (RXCUI in (select RXCUI from rxnconso where RXAUI in (select RXAUI1 from rxnrel where REL = :rel and RXAUI2 = :value))
Relationship Type
DescriptionAllows for the selection of a concept based on the type of its relationships
Property Name[RELA]
Operations Allowed= / in
Values AllowedCUI:[RXCUI] or AUI:[RXAUI] must be a valid CUI or AUI. Note that a CUI does not need to have an SAB=RXNORM entry to be used here
Comments[RELA] (:rela) is one of the relationship types defined in RxNorm Appendix 1 (the "RELA" column)
SQL for CUI: 
and (RXCUI in (select RXCUI from rxnconso where RXCUI in (select RXCUI1 from rxnrel where RELA = :rel and RXCUI2 = :value))
for AUI: 
and (RXCUI in (select RXCUI from rxnconso where RXAUI in (select RXAUI1 from rxnrel where RELA = :rel and RXAUI2 = :value))

RxNorm Properties

In addition to the standard properties, the following properties are defined for RxNorm:

(Yet to be done).

RxNorm Implicit Value Sets

Implicit value sets are those whose specification can be predicted based on the grammar of the underlying code system, and the known structure of the URL that refers to them. At the time of this publication, RxNorm does not define implicit value sets.

The identifier http://www.nlm.nih.gov/research/umls/rxnorm/vs represents a value set that contains all RxNorm CUIs.