SAVE THE DATE - #OHIE19 Nov 4-8, 2019 in Addis Ababa, Ethiopia - CLICK HERE
Skip to end of metadata
Go to start of metadata

Overview

Description: This transaction allows a PoS, or any OHIE component, to access terminological information in the terminology service to verify that a code is a member of defined value set.  A typical example would be to validate that the codes contained in an incoming patient data message are, in fact, from a required value set, e.g. the HIV ValueSet..

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. Membership: Is a Concept Code present in a specified Value Set. E,g., is Code  '123XYZ' from ICD-10 a member of the HIV ValueSet.?

Sponsor: Jack Bowie 

Status:  This operation has been extensively tested in FHIR Connectathons. 

Referenced Standards and APIs

Assumptions and Prerequisites

  • The required ValueSets and associated 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 Value Set for the health system.  

 

 

Technical details

RefInteractionEndpointDataTransaction Specification
1Code verification requestTS

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

Input: A Concept Code, associated Code System and target ValueSet.

 

FHIR ValueSet Resource, $validate-code operation
2.Code verification responsePoS

The response is sent back to the requesting system.

Output: a True or False response.

 FHIR ValueSet Resource, $validate-code operation