Rxnorm - FHIR v1.8.0

STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

4.2.2 Using RxNorm with FHIR

Vocabulary

Work Group

Maturity Level: N/A

Ballot Status: STU 3

4.2.2.1 Summary

Source

RxNorm is made available by the US National Library of Medicine

at http://www.nlm.nih.gov/research/umls/rxnorm

System

The URI http://www.nlm.nih.gov/research/umls/rxnorm

identifies the RxNorm code system

Version

Where a version is used, it should be the date of release, encoded as in the download files, e.g. "07092014"

Code

The code value for an RxNorm code is a Concept Identifier (CUI), and only CUIs for which there is an SAB=RXNORM

Display

The correct display for a CUI is the string description for it associated with the source RXNORM. Display values are not case sensitive

Inactive

Todo: Describe how it is determined which concepts are inactive

Subsumption

No Subsumption relationships are defined by RxNorm

Filter Properties

Several properties are defined as described below

4.2.2.2 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 terminology correctly against this database. These are provided for implementer convenience, and do not imply that any particular approach be used in implementations.

For example, the correct display name for a CUI is 'Select STR from rxnconso where RXCUI = :code and SAB = 'RXNORM' and TTY <> 'SY'.

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

4.2.2.4 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'

4.2.2.4.1 Semantic Type

Description

Allows for the selection of a set of CUIs based on their Semantic Type

Property Name

STY

Operations Allowed

= / in

Values Allowed

[column:]value

Comments

If not column is specified, the default column is TUI

SQL

and RXCUI in (select RXCUI from rxnsty where [:column] = :value)

4.2.2.4.2 Source

Description

Allows for the selection of a set of concepts that have mappings to a particular RxNorm concept

Property Name

SAB

Operations Allowed

= / in

Values Allowed

Values from RxNorm SAB table (e.g. select RSAB from rxnsab)

SQL

and RXCUI in (select RXCUI from rxnconso where SAB = :value)

4.2.2.4.3 Term Type

Description

Allows for the selection of a concept based on its designated type

Property Name

TTY

Operations Allowed

= / in

Values Allowed

TTY values from the RxNorm Concept table (e.g. select distinct TTY from rxnconso)

SQL

and TTY = :value

4.2.2.4.4 Relationship

Description

Allows for the selection of a concept based on its relationships

Property Name

[REL]

Operations Allowed

= / in

Values Allowed

CUI:[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))

4.2.2.4.5 Relationship Type

Description

Allows for the selection of a concept based on the type of its relationships

Property Name

[RELA]

Operations Allowed

= / in

Values Allowed

CUI:[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))

4.2.2.5 RxNorm Properties

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

(Yet to be done).

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