The official version of the OHIE workflows can be found in the OpenHIE Architecture Specification.


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


title Verify Code Membership  
participant PoS  
participant TS 

PoS->TS: [1] Code verification request 
TS->PoS: [2] Code verification response 

Technical details

Below enter each interaction that makes up the described workflow above.

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