Developer Guide - Query Design

Supported message formats and interfaces

The generic query supports the Nictiz MP-MGR transaction through two message formats: HL7v3/CDA and FHIR.

Clients can access the generic query via AORTA-LSP using the interfaces:

• The AORTA-LSP HL7v3/CDA transaction – Generieke query naar LSP

• The AORTA-LSP AoF FHIR call – $get-aorta-data

For the MP standard, AORTA-LSP currently provides only the generic query to GBx resource clients. Building block–specific queries are not directly available to GBx resource clients; instead, these specific queries are used internally by AORTA-LSP and LSP+ in their function as information brokers.

Supported system roles

For FHIR-based GBx resource clients, the available functionality is intentionally limited to the generic query. This restriction is enforced through TKID management. FHIR-based GBx resource clients are assigned only the following system roles:

• Operation Initiërend Systeem (OIS) system role: $get-aorta-data.OIS.R4.1

• Search result Ontvangend Systeem (SOS) system roles, one for each supported building block

Access to building block–specific queries is disabled by not assigning the SIS Search Initiërend Systeem roles.

These SIS roles correspond to the building blocks that can be retrieved through specific queries.

Supported building blocks

These are the underlying building block which are retrieved via specific queries;

The contextcode which is used as argument in the generic query determines which building blocks are in scope.

The verstrekkingsverzoek is only queryable by the patient.

Supported filtering

The generic query supports filtering. Parameters can be used as filter arguments for the generic query. However, the naming of these parameters is not yet harmonized across the generic query, the building block–specific queries, the HL7v3 and FHIR message formats, and the Nictiz information standard.

Execution of Generic Queries via AORTA-LSP

The generic query is executed as a series of building block–specific queries directed at the GBx resource servers.
The resulting data is subsequently consolidated into a single, unified response.

Within the MP9 context, the generic query is composed of discrete queries for each MP9 building block. The AORTA-LSP is responsible for performing message format transformations between GBx resource clients and servers. Furthermore, it ensures compliance with the applicable authorization rules governing the end user of the query, whether this is a care professional or a patient.

Nictiz transaction

This is the conceptual Nictiz transaction that supports querying. It is used to query the building blocks for a specific patient.

AORTA-LSP HL7v3/CDA transaction

This is the AORTA-LSP HL7v3/CDA transaction that realizes the conceptual Nictiz transaction.

Scenario

Dataset and Template

VZVZ maps this to this dataset and corresponding template.

Data elements

This results in the following data structure for a parameter of the generic query.

hl7:GQZG_IN000001NL02
>hl7:ControlActProcess
>>hl7:queryByParameter
>>>hl7:parameter
>>>>hl7:value
>>>>hl7:semanticsText

AORTA-LSP AoF FHIR call

This is the AORTA-LSP AoF FHIR call that realizes the conceptual Nictiz transaction.

See Interfaces Resource Broker ZA-in

Call Syntax

GET [base]$get-aorta-data
?[context]
{&[destination]}
{&[effective-time]}
{&[therapy-identifier]}
{&[classifier]}
{&[instance-identifier]}

MP9v3 generic query parameters

Below is the mapping of parameter names between the HL7v3 and FHIR message formats, and the Nictiz information standard.

Column AoF corresponds to the parameters for the AORTA-LSP AoF FHIR call.

Column HL7v3 corresponds to the parameters in the AORTA HL7v3/CDA Dataset and Template.

Parameter naming in different contexts

• The Functional Design (FD) defines the Nictiz parameters.

• The Generic Query via the AoF route uses the FHIR operation $get-aorta-data, which relies on predefined (abstract) parameters.

• The Specific Query building blocks via the AoF route use FHIR search per resource, applying the corresponding FHIR search parameters.

• The Generic Query via the ZIM route uses HL7v3 parameters.