query-value-set.md

Query Value Set

This transaction allows a PoS, or any OHIE component, to access terminological information in the terminology service to query for Value Sets. A typical example would be to request the set of Value Sets defined by WHO.

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. Query ValueSets: What Value Sets have a publisher name that contains 'WHO'?

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		The FHIR Value Sets and supported search parameters are defined in: https://www.hl7.org/fhir/valueset.html. Searching in FHIR is described in https://www.hl7.org/fhir/search.html. HL7 FHIR Specifications v3.0 or higher support Value Set. The response is a Bundle of Value Set Resources satisfying the search parameters. This workflow implements the IHE IT Infrastructure Technical Framework Supplement - Sharing Valuesets, Codes, and Maps (SVCM) Transaction: Query Value Set ITI-Y1.
Assumptions and Prerequisites		The required ValueSets have been preloaded into the Terminology Service.
Actors		PoS - The point-of-service system or other HIE component that is that is querying for Value Sets. TS - Stores the curated, official version of the Value Sets for the health system.

Interaction Description

The following is a description of the interaction steps.

#	Interaction	Data	Transaction Options
1	Query Value Set request	The Value Set search request is triggered by a PoS or other HIE component. Input: A set of FHIR search parameters.	FHIR ValueSet Resource
2	Query Value Set response	The response is sent back to the requesting system. Output: a Bundle of ValueSet Resources that satisfy the search parameters.	FHIR ValueSet Resource