Michal Ciszewski: /* FHIR Search examples */

2026-09-30T12:25:01Z

‎FHIR Search examples

Michal Ciszewski: /* FHIR Search parameters */

2026-09-30T12:24:45Z

‎FHIR Search parameters

Marija Zivlak op 7 jul 2026 om 12:33

2026-07-07T12:33:14Z

Marija Zivlak: Nieuwe pagina aangemaakt met ' {{DISPLAYTITLE: Technical Design Lab2patient v2.0.0-beta.1}} ''The Information Standard Lab Exchange consists of four different components: Lab2...'

2026-07-07T12:24:03Z

Nieuwe pagina aangemaakt met ' {{DISPLAYTITLE: Technical Design Lab2patient v2.0.0-beta.1}} ''The Information Standard Lab Exchange consists of four different components: Lab2...'

Nieuwe pagina

{{DISPLAYTITLE: Technical Design Lab2patient v2.0.0-beta.1}}

''The Information Standard Lab Exchange consists of four different components: Lab2Zorg, Lab2Lab, Lab2PublicHealth, and Lab2Patient. These four components were developed independently of each other and are subject to continuous development. This is reflected in the Semantic Versioning (SemVer). Each component undergoes its own development process with its own corresponding numerical publications.''

{{IssueBox| The FHIR resource used for the use case described in this technical design is DiagnosticReport. DiagnosticReport is not the preferred FHIR resource for the information standard Laboratory exchange. However, this resource has been chosen as it contains information about the order data. Optimally, order data could be linked directly to the preferred FHIR resource Observation via basedOn element. This will be updated in a future version.}}

<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]
circle 1013 224 212 [[L2p:v2.0.0_ontwerp_lab2patient|Functional]]
circle 1787 230 212 [[L2p:v2.0.0_FHIR_lab2patient|Technical]]
desc none
</imagemap>

<big>For an overview of all current documentation [[Landingspagina_Labuitwisseling| see information standard lab exchange main page]]</big>

__NUMBEREDHEADINGS__

==Introduction==
[[Bestand:Functioneel-02.png|link=Lab:V1.0.0-beta.2_Ontwerp_Lab2Patient|100px|rechts|Functional design|Go to functional design]]

This is the technical design (TO) for the information standard (IS) Lab2patient. This TO must be used together with the IS functional design, see [[Lab:V1.0.0-beta.2_Ontwerp_Lab2Patient| functional design Lab2patient 1.0.0-beta.2]]. The data exchange format used in this version is: FHIR R4.

=== Support ===
For questions, feedback, or change requests, please contact our support team at [https://nictiz.atlassian.net/servicedesk/customer/portal/4 Nictiz Servicemanagement].

=== Boundaries ===
This information standard may overlap with other standards related to identification, roles, and geographic classifications, requiring careful alignment to ensure consistency and avoid duplication. For more information, see [[Lab:V1.0.0-beta.2_Ontwerp_Lab2Patient| functional design Lab2patient 1.0.0-beta.2]].

=== Prerequisite knowledge ===
The following background information is required for understanding this TO:
* The [[Lab:V1.0.0-beta.2_Ontwerp_Lab2Patient| functional design Lab2patient 1.0.0-beta.2]] accompanying this TO.
* The data exchange format FHIR R4, which you can find here:
** [[FHIR:V1.0 FHIR IG R4|general FHIR R4 Implementation Guide]],
** [[FHIR:V1.0_FHIR_IG_R4#FHIR_Packages|FHIR packages]],
** [[FHIR:V1.0_FHIR_IG_R4#Usage_of_the_.id.2C_.identifier_and_.fullUrl_elements_in_FHIR_instances|usage of the .id, .identifier and .fullUrl]].

== Relationships ==

The diagram below shows the relationships between different FHIR profiles. The arrows indicate an “is referenced in” relationship.

For example, Patient → Laboratory Test means that the Patient is referenced within the Laboratory Test resource.

[[Bestand:FHIR-model-overview-L2P.png]]

==Components==

HL7 FHIR is used to accommodate the Dutch Clinical Information Models (zibs) used in the IS.

=== HL7 FHIR R4 ===
{{NoteBoxNictizR4Package|p1=nictiz.fhir.nl.r4.labexchange|v1=4.0.0-beta.2|p2=nictiz.fhir.nl.r4.nl-core|v2=0.12.0-labtrial.1|p3=nictiz.fhir.nl.r4.zib2020|v3=0.12.0-labtrial.1}}

==== Artifacts ====

The artifacts of the information standard are presented in the following table:
{| style="text-align: left; background-color: white;" cellpadding=5px;

|- style="color: white; background-color: #e7844b;"
! zib
! FHIR resource
! FHIR profile

|- style="background-color: #fcf0e9;"
| HealthcareProvider
| Organization
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-beta.1|title=nl-core-HealthcareProvider-Organization}}

|- style="background-color: #fcf0e9;"
| rowspan="2" | HealthProfessional
| Practitioner
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-beta.1|title=nl-core-HealthProfessional-Practitioner}}

|- style="background-color: #fcf0e9;"
| PractitionerRole
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-beta.1|title=nl-core-HealthProfessional-PractitionerRole}}

|- style="background-color: #fcf0e9;"
| rowspan="3" | LaboratoryTestResult
| Device
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-LaboratoryTestResult.Specimen.Source|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.7.0-beta.1|title=nl-core-LaboratoryTestResult.Specimen.Source}}

|- style="background-color: #fcf0e9;"
| Observation
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-LaboratoryTestResult|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-labtrial.1|title=nl-core-LaboratoryTestResult}}

|- style="background-color: #fcf0e9;"
| Specimen
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-LaboratoryTestResult.Specimen|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-beta.1|title=nl-core-LaboratoryTestResult.Specimen}}

|- style="background-color: #fcf0e9;"
| Patient
| Patient
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient|nictiz.fhir.nl.r4.nl-core|pkgVersion=0.12.0-beta.1|title=nl-core-Patient}}

|- style="background-color: #fcf0e9;"
|
| DiagnosticReport
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/lu-LaboratoryTestResult-DiagnosticReport|nictiz.fhir.nl.r4.labexchange|pkgVersion=4.0.0-beta.2|title=lu-LaboratoryTestResult-DiagnosticReport}}

|- style="background-color: #fcf0e9;"
|
| ServiceRequest
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/lu-OrderData|nictiz.fhir.nl.r4.labexchange|pkgVersion=4.0.0-beta.2|title=lu-OrderData}}
|}

==== Examples of FHIR instances ====
You can find examples of FHIR-instances (filled-in FHIR profiles) in the Nictiz GitHub repository: [https://github.com/Nictiz/HL7-mappings/tree/master/ada_2_fhir-r4/lab/1.0.0-alpha.1 <nowiki>Lab exchange HL7-mappings repository</nowiki>].

== Transactions ==
=== Patient retrieves laboratory results in their PGO ===
==== Involved actors ====
{| style="text-align: left;" cellpadding=5px;

|- style="color: white; background-color: #e7844b;"
! Transaction group || Transaction || Actor || System role code || FHIR CapabilityStatement

|- style="background-color: #fcf0e9;"
| rowspan="2" | Retrieve laboratory results (PULL)
| Retrieve laboratory results request || Client || LAB-LRR-PGO || rowspan="2" |{{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/Lab2Patient-Results-RetrieveServe|nictiz.fhir.nl.r4.labexchange|pkgVersion=4.0.0-beta.2|title=Lab2Patient_Results_RetrieveServe}}

|- style="background-color: #fcf0e9;"
| Retrieve laboratory results response || Server || LAB-LRB-PGO

|+ style="align: bottom; caption-side: bottom; text-align: left;" | ''Abbreviations: LAB = Laboratorium, LRR = Laboratoriumresultaat raadplegend (systeem), LRB = Laboratoriumresultaat beschikbaarstellend (systeem), PGO = Persoonlijke gezondheidsomgeving.''
|}

==== FHIR Search parameters ====
The search interaction is performed by an HTTP GET in agreement with the [http://hl7.org/fhir/R4/search.html FHIR specification].

Unless stated otherwise, all (repetitions of) parameters and their values SHALL be supported by servers. Parameters with minimum of 1 or up SHALL be supported by clients.

# = number of occurrences of the parameter. Results shall match all occurrences
Value # = number of value occurrences per occurrence of the parameter. Results shall match at least of the value occurrences

Example: {{fhir|1=/Patient?language=FR,NL&language=EN}} would refer to any patient who speaks English, as well as either French or Dutch. language may thus repeat, and may have more than one value.

The table below lists search parameters for {{fhir|DiagnosticReport}} resource.

{| style="text-align: left; width: 100%" cellpadding=5px;
|- style="color: white; background-color: #e7844b;"
! Name || # || Value # || Type || Description

|- style="background-color: #fcf0e9;"
| {{fhir|result.category}} || 1..1 || 1..1 || token || Search DiagnosticReports that reference laboratory observations. Fixed value: {{fhir|<nowiki>https://terminology.hl7.org/CodeSystem/observation-category|laboratory</nowiki>}}

|- style="background-color: #fcf0e9;"
| {{fhir|result.code}} || 0..* || 1..* || token || Limit results to DiagnosticReports with observations containing a LOINC or an NHG test code. {{fhir|<nowiki>http://loinc.org|[test code]</nowiki>}}, {{fhir|<nowiki>https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|[test code]</nowiki>}}

|- style="background-color: #fcf0e9;"
| {{fhir|result.date}} || 0..2 || 1..1 || date || Search on DiagnosticReports including observations with date earlier or later than the value. To be used with prefixes {{fhir|lt}} or {{fhir|gt}}.

|- style="background-color: #fcf0e9;"
| {{fhir|_include}} || 0..* || 1..1 || reference || Include linked resource, can be used in conjunction with modifier {{fhir|iterate}} which includes resources iteratively.

|+ style="align: bottom; caption-side: bottom; text-align: left;" |
|}

==== Chaining parameters ====

Chained search parameters are used to apply criteria to resources referenced by {{fhir|DiagnosticReport}}. In this use case, Observation criteria are applied through {{fhir|DiagnosticReport.result}}, for example by using {{fhir|result.code}}, {{fhir|result.category}}, and {{fhir|result.date}} to search for reports that reference matching Observations. For more information on chaining, consult [https://build.fhir.org/search.html#chaining FHIR specification].

==== Most recent functionality ====

To retrieve the most recent reports, clients SHALL use the regular FHIR search interaction on {{fhir|DiagnosticReport}} in combination with sorting and paging parameters. The parameter {{fhir|_sort}} with value {{fhir|-date}} is used to sort reports by date in descending order. The parameter {{fhir|_count}} can be used to limit the number of {{fhir|DiagnosticReport}} resources returned.

==== FHIR Search examples ====

{| style="text-align: left; width: 100%;" cellpadding=5px;
|- style="color: white; background-color: #e7844b;"
! Examples

|- style="color: white; background-color: #eda778;"
! Show all DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC)

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&_include=DiagnosticReport:result</pre>

|- style="color: white; background-color: #eda778;"
! Show all DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC) from 12 March 2022

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&result.date=gt2022-03-12&_include=DiagnosticReport:result</pre>

|- style="color: white; background-color: #eda778;"
! Show all DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC) between 12 March 2022 and 7 June 2022

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&result.date=gt2022-03-12&result.date=lt2022-06-07&_include=DiagnosticReport:result</pre>

|- style="color: white; background-color: #eda778;"
! Show all DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC) or 3583 (NHG)

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7,https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|3583&_include=DiagnosticReport:result</pre>

|- style="color: white; background-color: #eda778;"
! Show the most recent DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC)

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&_sort=-date&_count=1&_include=DiagnosticReport:result</pre>

|- style="color: white; background-color: #eda778;"
! Show the five most recent DiagnosticReports with laboratory Observations with test code 14683-7 (LOINC)

|- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
| <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&_sort=-date&_count=5&_include=DiagnosticReport:result</pre>

|+ style="align: bottom; caption-side: bottom; text-align: left;" |
|}

@@ Regel 187: / Regel 187: @@
 |- class="mw-collapsible mw-collapsed" style="background-color: #fcf0e9;"
 | <pre>GET [base]/DiagnosticReport?result.category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&result.code=http://loinc.org|14683-7&result.date=gt2022-03-12&result.date=lt2022-06-07&_include=DiagnosticReport:result</pre>
 |- style="color: white; background-color: #eda778;"

@@ Regel 145: / Regel 145: @@
 |- style="background-color: #fcf0e9;"
-| {{fhir|result.code}} || 0..* || 1..* || token || Limit results to DiagnosticReports with observations containing a LOINC or an NHG test code. {{fhir|<nowiki>http://loinc.org|[test code]</nowiki>}}, {{fhir|<nowiki>https://referentiemodel.nhg.org/tabellen/nhg-tabel-45-diagnostische-bepalingen|[test code]</nowiki>}}
+| {{fhir|result.code}} || 0..1 || 1..* || token || Limit results to DiagnosticReports with observations containing a LOINC test code. {{fhir|<nowiki>http://loinc.org|[test code]</nowiki>}}
 |- style="background-color: #fcf0e9;"

@@ Regel 8: / Regel 8: @@
 <imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch
 circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]
-circle 1013 224 212 [[L2p:v2.0.0_ontwerp_lab2patient|Functional]]
+circle 1013 224 212 [[L2p:V2_ontwerp_lab2patient|Functional]]
-circle 1787 230 212 [[L2p:v2.0.0_FHIR_lab2patient|Technical]]
+circle 1787 230 212 [[L2p:V2_FHIR_lab2patient|Technical]]
 desc none
 </imagemap>

L2p:V2 FHIR lab2patient - Bewerkingsoverzicht

Michal Ciszewski: /* FHIR Search examples */

Michal Ciszewski: /* FHIR Search parameters */

Marija Zivlak op 7 jul 2026 om 12:33

Marija Zivlak: Nieuwe pagina aangemaakt met ' {{DISPLAYTITLE: Technical Design Lab2patient v2.0.0-beta.1}} ''The Information Standard Lab Exchange consists of four different components: Lab2...'