OpenHIE Architecture Specification
5.2-en
5.2-en
  • Specification Overview
    • GitBook Version Change Control Process
    • How to use the Specification
    • Version Change Log
    • How to Provide Feedback and Input
  • 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
  • Data 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
    • OpenHIE Finance and Insurance Services Workflows
      • HFW-001: Enroll Beneficiary
      • HFW-002: Query Beneficiary
      • HFW-003: Check Coverage Eligibility
      • HFW-004: Claiming
      • HFW-005: Claim Tracking
Powered by GitBook
On this page
  • Interaction Description
  1. Data Exchange Specification
  2. Terminology Service Workflows

Verify Code Existence

PreviousTranslate CodeNextVerify Code Membership

Last updated 2 years ago

This transaction allows a PoS, or any OHIE component, to access terminological information in the terminology service to verify that a code exists. A typical example would be to validate that the codes contained in an incoming patient data message are, in fact, from a required code system, e.g. ICD-10 or LOINC.

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. Existence: Is a Concept Code present in a specified Code System. E,g., is '123XYZ' a valid Code in the ICD-10 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: Validate Code ITI-Y5 for Code Systems.

Assumptions and Prerequisites

The required CodeSystems have been preloaded into the Terminology Service.

Actors

  • PoS - The point-of-service system or other HIE component that is requesting to verify 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 verification 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, $validate-code operation

2

Code verification response

The response is sent back to the requesting system. Output: a True or False response.

FHIR CodeSystem Resource, $validate-code operation

The FHIR CodeSystem validate-code operation: . HL7 FHIR Specifications v3.0 or higher support validate-code. The response is a Boolean (true or false) based on whether the code exists in the specified CodeSystem.

http://build.fhir.org/codesystem-operation-validate-code.html