OpenHIE Architecture Specification
4.0
4.0
  • Specification Overview
  • How to use the Specification
  • Architecture Specification
    • Architecture
    • Architectural Principles
    • Standards and Profiles
  • OpenHIE Component Specifications
    • Non-Functional Requirements
    • Client Registry (CR)
    • OpenHIE Facility Registry (FR)
    • OpenHIE Finance and Insurance Service (FIS)
    • OpenHIE Health Management Information System (HMIS)
    • OpenHIE Health Worker Registry (HWR)
    • OpenHIE Interoperability Layer (IOL)
    • OpenHIE Logistics Management Information System (LMIS)
    • OpenHIE Product Catalogue (PC)
    • OpenHIE Shared Health Record (SHR)
    • OpenHIE Terminology Service (TS)
    • Point-Of-Care Systems
  • Workflow (Exchange) Specification
    • Aggregate Reporting Workflows
      • Export Aggregate Data
      • Validate and Save Aggregate Data
    • Alerting / Sending Reminders or Information
      • Send Client Alert Workflow
      • Send Health Worker Alert Workflow
    • Care Services Discovery
      • Query Health Worker and/or Facility Records Workflow
      • Query Care Services Records Workflow
      • Search Care Services Workflow
      • Request Care Services Updates Workflow
    • Laboratory Work Flows
      • Order Laboratory Test
      • Report Lab Results
    • Patient Identity Management Workflows
      • Create Patient Demographic Record Workflow
      • Update Patient Demographic Record Workflow
      • Query Patient Demographic Records by Identifier Workflow
      • Query Patient Demographic Records by Demographics Workflow
    • Shared Health Record
      • Save Patient-level Clinical Data Workflow
      • Query Patient-level Clinical Data Workflow
    • Terminology Service Workflows
      • Expand Value Set
      • Translate Code
      • Verify Code Existence
      • Verify Code Membership
      • Query Value Set
      • Query Code Systems
      • Query Concept Maps
      • Lookup Code
    • Vaccine Workflows
  • How to Provide Feedback and Input
  • Change Log and Versioning
Powered by GitBook
On this page
  1. Workflow (Exchange) Specification
  2. Terminology Service Workflows

Lookup Code

PreviousQuery Concept MapsNextVaccine Workflows

Last updated 3 years ago

This transaction allows a PoS, or any OHIE component, to access terminological information in the terminology service to retrieve detailed information on a code. A typical example would be to retrieve descriptive information on a laboratory code from the LOINC Code System.

Both external systems and systems inside the HIE may perform this transaction directly with the TS. The sequence diagram below shows the steps that occur for a system using this transaction.

  1. Lookup: Retrieve information on Code '26453-1' in the LOINC Code System.

Workflow Maturity

Mature

  • One or more OpenHIE implementations of this workflow exist in one or more countries

  • Workflow is defined and ARB approved

  • Workflow is supported by mature standards

Standards*

This workflow implements the IHE IT Infrastructure Technical Framework Supplement - Sharing Valuesets, Codes, and Maps (SVCM) Transaction: Lookup Code ITI-Y4.

Assumptions and Prerequisites

The required CodeSystems have been preloaded into the Terminology Service and the specified code exists in the Code System.

Actors

  • PoS - The point-of-service system or other HIE component that is requesting to lookup a code.

  • TS - Stores the curated official version of the terminology and codes for the health system.

Interaction Description

The following is a description of the interaction steps.

Ref

Interaction

Data

Transaction Options

1

Code Lookup request

The validate-code request is triggered by a PoS or other HIE component.

Input: A Concept Code and target Code System.

FHIR CodeSystem Resource, $lookup operation

2

Code Lookup response

The response is sent back to the requesting system.

Output: an object containing code information.

FHIR CodeSystem Resource, $lookup operation

The FHIR CodeSystem lookup operation: . HL7 FHIR Specifications v3.0 or higher support lookup. The response is an object that contains details about the code, including definition, status, designations, and properties.

https://www.hl7.org/fhir/codesystem-operation-lookup.html