Observation Codes CSV API

The following page defines data and fields that may be imported into MIE systems (WebChart, Enterprise Health) to create observation codes using the Observation Codes CSV API.

Audience

The abstract that follows should be presented to decision-makers or stakeholders interested in a general explanation of the Observation Codes CSV API. Technical details are provided in the remaining sections.

Abstract

The Observation Codes CSV API imports the details that comprise how observations are classified in the system.

CSV refers to the type of file and format of data needed to import information into the WC system. API refers to how the data interacts with the WC system. See the Import Overview page for a more detailed explanation of terminology.

Screenshots

The first screenshot shows a simple CSV file containing the required field and several of the best practice fields. This example data is available for full inspection on the tab “Example” in the specification (see link in Specification section of this page).

This screenshot shows how the Bilirubin observation code should appear when viewing in the Observation Codes Manager after the import has been run with the example CSV file.

And this final screenshot shows how the RBC observation code should appear when viewing in the Observation Codes Manager after the import has been run with the example CSV file.

Specifications

The following sections provide insight for technical personnel working with the provided import specifications. Although the specifications provided include details on each field utilized in the import, the sections below include further discussion on best practices for imported data to provide the best functionality in the WebChart system.

The Observation Codes CSV API specifications are available here.

Note
The specification may be downloaded as Excel, CSV, or duplicated as an online spreadsheet under the File menu.

Additionally, user instructions are available for importing data into the WC system.

Column Definitions and Specific Coded Values

Definitions for the columns utilized in the specification, as well as commonly used specific coded values appear on the Data Import Standards page.

Field Requirements

The following fields (indicated in the Data Name column) are noted as required (R) or are recommended as best practice (BP) in the Observation Codes CSV API specification. Additional details and considerations are provided here.

Required

The following field is required:

  • Observation Name (observation_codes.obs_name) is used to uniquely identify an observation code record.
Best Practice

Although this information is not required, it is considered a best practice to use at least some of these fields to better specify information in the observation code:

  • Observation Code (observation_codes.obs_code) is the unique numerical id value of the observation code record. If this is given, a mapping of the Vendor Result Code (observation_codes.hl7_code) will be created to this value. This is useful when the observation code of the same name already exists in the system and merely a new mapping for the given vendor(lab) is desired.
  • Observation Type (observation_codes.obs_type) is the type of data that the observation is storing; ‘DATETIME’ for dates/datetimes, ‘DECIMAL’ for numeric values, & ‘TEXT’ for results that won’t have any formatting constraints.
  • Vendor Result Code (observation_codes.hl7_code) is the code used by the vendor(lab) when sending a result of this observation.
  • Observation Range (observation_codes.obs_range) is the range of values that would be considered ‘normal’ for this observation. The units of this range will be specified by the Units (observation_codes.obs_units) field.
  • Units (observation_codes.obs_range) specifies the default unit of the observation as well as the Observation Range (observation_codes.obs_range).
  • LOINC Code (observation_codes.loinc_num) specifies the globally recognized identifier as outlined by LOINC.
Optional Fields
  • Template ID (observation_codes.template_id) specifies the CDA/CCD section where the observation appears.
  • Target Type (observation_codes.target_type) specifies the type of comparison that is done with the result. Options are ‘target’, ‘range’, & ‘abrange’. If ‘range’ or ‘abrange’ is specified, no value need be specified for the Target field, but rather the Observation Range field. ‘range’ looks at the Observation Range as the normal range of values whereas ‘abrange’ treats it as the abnormal range of values.
  • Target (observation_codes.target) is the specific target value desired. Only applicable if Target Type is ‘target’.
  • English Units (observation_codes.english_units) specifies the desired unit to be used when displaying the result and the user’s Preferred Unit System is ‘English’.
  • Metric Units (observation_codes.metric_units) specifies the desired unit to be used when displaying the result and the user’s Preferred Unit System is ‘Metric’.

Example

Example using sample data is provided on Example tab in the specification.

WebChart Documentation
Last Build: Wed, 08 Sep 2021 00:25:59 EDT Legacy Documentation