Parameters

Parameters play a role in both the generic query with contextcode as well in buildingblock specific queries.

The generic query parameters are mapped to buildingblock specific queries by the AORTA-LSP. Data sources are queried by the AORTA-LSP using buildingblock specific queries.

Nictiz Parameter	Patient.IdentificatieNumber
Nictiz Omschrijving	Identificatienummer van de patiënt. Bij overdrachtsituaties dient het gebruik van het burgerservicenummer (BSN) in overeenstemming te zijn met de 'Wet gebruik burgerservicenummer in de zorg (Wbsn-z)'. In andere situaties kunnen andere nummersystemen gebruikt worden, zoals bijv. interne ziekenhuis patiëntnummers.
Description	Search on patient
FHIR search parameter	patient.identifier
AoF $get-aorta-data parameter	patient specifiek
HL7v3	patient specifiek
Example	CODE `GET [base]/MedicationRequest ?identifier=urn:oid:{root}\|{ext}`
FHIR Impl Guide	MP9 patient.identifier or subject:Patient.identifier MedMij Oauth2 tokens AORTA-LSP tokens
VZVZ Generieke Geparameteriseerde Query Zorggegevens	patient specifiek
VZVZ Opvragen Doseerschema	patient specifiek
VZVZ Opvragen Medicatieafspraken	patient specifiek
VZVZ Opvragen Medicatiegebruik	patient specifiek
VZVZ Opvragen Medicatieverstrekkingen	patient specifiek
VZVZ Opvragen Toedieningen	patient specifiek
VZVZ Opvragen Toedieningsafspraken	patient specifiek
VZVZ Opvragen Verstrekkingsverzoeken	patient specifiek

Nictiz Parameter	Mbh.Identificatie
Nictiz Omschrijving	Welke identificatie heeft de medicamenteuze behandeling die wordt gevraagd?
Description	Search on the pharmaceutical treatment identifier. Note: retrieval of all medication resources belonging to one pharmaceutical treatment requires to search on all medication resource types.
FHIR search parameter	pharmaceutical-treatment-identifier
AoF $get-aorta-data parameter	therapy-identifier
HL7v3	MBHid
Example	CODE `GET [base]/MedicationRequest ?pharmaceutical-treatment-identifier=urn:oid:{root}\|{ext}`
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| PharmaceuticalTreatmentIdentifier - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	MBHid
VZVZ Opvragen Doseerschema	MBHid
VZVZ Opvragen Medicatieafspraken	MBHid
VZVZ Opvragen Medicatiegebruik	MBHid
VZVZ Opvragen Medicatieverstrekkingen	MBHid
VZVZ Opvragen Toedieningen	MBHid
VZVZ Opvragen Toedieningsafspraken	MBHid
VZVZ Opvragen Verstrekkingsverzoeken	MBHid

Nictiz Parameter	Bouwsteen.Identificatie
Nictiz Omschrijving	Welke identificatie hebben de bouwstenen: MA, WDS, VV, TA, MVE, MGB, MTD die worden gevraagd?
Description	Search on identifier.
FHIR search parameter	identifier
AoF $get-aorta-data parameter	instance-identifier
HL7v3	Identificatie
VZVZ Generieke Geparameteriseerde Query Zorggegevens	Identificatie
VZVZ Opvragen Doseerschema	Identificatie
VZVZ Opvragen Medicatieafspraken	Identificatie
VZVZ Opvragen Medicatiegebruik	Identificatie
VZVZ Opvragen Medicatieverstrekkingen	Identificatie
VZVZ Opvragen Toedieningen	Identificatie
VZVZ Opvragen Toedieningsafspraken	Identificatie
VZVZ Opvragen Verstrekkingsverzoeken	Identificatie

Nictiz Parameter	Bouwsteen.Type
Nictiz Omschrijving	Welk type medicatiebouwstenen wordt er gevraagd? Alle onderliggende medicatiebouwstenen van het gekozen type die voldoen aan de overige queryparameters, worden meegeleverd.
Description	Search on type of medication building block.
FHIR search parameter	category
AoF $get-aorta-data parameter	context (context determines building blocks)
HL7v3	impliciet o.b.v. contextCode
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| Category - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	impliciet o.b.v. contextCode
VZVZ Opvragen Doseerschema	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Medicatieafspraken	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Medicatiegebruik	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Medicatieverstrekkingen	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Toedieningen	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Toedieningsafspraken	impliciet o.b.v. bouwsteen specifieke interactie
VZVZ Opvragen Verstrekkingsverzoeken	impliciet o.b.v. bouwsteen specifieke interactie

Examples

Retrieves all MedicationRequest resources that represent the building block MedicationAgreement.

CODE

GET [base]/MedicationRequest?category=http://snomed.info/sct|33633005

Retrieves all MedicationRequest resources that represent the building block DispenseRequest.

CODE

GET [base]/MedicationRequest?category=http://snomed.info/sct|52711000146108

Retrieves all MedicationRequest resources that represent the building block VariableDosingRegimen.

CODE

GET [base]/MedicationRequest?category=http://snomed.info/sct|395067002

Retrieves all MedicationDispense resources that represent the building block MedicationDispense.

CODE

GET [base]/MedicationDispense?category=http://snomed.info/sct|373784005

Retrieves all MedicationDispense resources that represent the building block AdministrationAgreement.

CODE

GET [base]/MedicationDispense?category=http://snomed.info/sct|422037009

Retrieves all MedicationStatement resources that represent the building block MedicationUse2.

CODE

GET [base]/MedicationStatement?category=http://snomed.info/sct|422979000

Retrieves all MedicationAdministration resources that represent the building block MedicationAdministration2.

CODE

GET [base]/MedicationAdministration?category=http://snomed.info/sct|18629005

Nictiz Parameter	Productcode
Nictiz Omschrijving	Search on medication code.
Description	Search on type of medication building block.
FHIR search parameter	medication.code
AoF $get-aorta-data parameter	-
HL7v3	ProductCode
VZVZ Generieke Geparameteriseerde Query Zorggegevens	ProductCode
VZVZ Opvragen Doseerschema	ProductCode
VZVZ Opvragen Medicatieafspraken	ProductCode
VZVZ Opvragen Medicatiegebruik	ProductCode
VZVZ Opvragen Medicatieverstrekkingen	ProductCode
VZVZ Opvragen Toedieningen	ProductCode
VZVZ Opvragen Toedieningsafspraken	ProductCode
VZVZ Opvragen Verstrekkingsverzoeken	ProductCode

Nictiz Parameter	Gebruiksperiode
Nictiz Omschrijving	Op welke periode van (beoogd) gebruik hebben de medicatieafspraken, wisselend doseerschema's, toedieningsafspraken en medicatiegebruik betrekking? Alle geretourneerde MA, WDS, TA en MGB hebben betrekking op medicatie die binnen deze periode is gebruikt, gebruikt wordt of zal worden gebruikt.
Description	On what period of (intended) use are the MedicationAgreements, VariableDosingRegimen, AdministrationAgreements and MedicationUse applicable? All the MedicationAgreements VariableDosingRegimen, AdministrationAgreements and MedicationUse, relate to medication that was used, is used or will be used during the indicated period.
FHIR search parameter	period-of-use
AoF $get-aorta-data parameter	effective-time
HL7v3	GebruiksPeriode
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| PeriodOfUse - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	GebruiksPeriode
VZVZ Opvragen Doseerschema	GebruiksPeriode
VZVZ Opvragen Medicatieafspraken	GebruiksPeriode
VZVZ Opvragen Medicatiegebruik	GebruiksPeriode
VZVZ Opvragen Medicatieverstrekkingen	n.v.t.
VZVZ Opvragen Toedieningen	n.v.t.
VZVZ Opvragen Toedieningsafspraken	GebruiksPeriode
VZVZ Opvragen Verstrekkingsverzoeken	n.v.t.

Nictiz Parameter	Verstrekkingsperiode
Nictiz Omschrijving	In welke periode zijn de verstrekkingen gedaan die worden gevraagd? Opgeleverd worden alle verstrekkingen waarvan de datum binnen de hier gespecificeerde periode vallen.
Description	In what period were the requested dispenses carried out? All dispenses with a date within the specified period will be produced.
FHIR search parameter	whenhandedover
AoF $get-aorta-data parameter	effective-time
HL7v3	VerstrekkingsPeriode
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| PeriodOfUse - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	VerstrekkingsPeriode
VZVZ Opvragen Doseerschema	n.v.t.
VZVZ Opvragen Medicatieafspraken	n.v.t.
VZVZ Opvragen Medicatiegebruik	n.v.t.
VZVZ Opvragen Medicatieverstrekkingen	VerstrekkingsPeriode
VZVZ Opvragen Toedieningen	n.v.t.
VZVZ Opvragen Toedieningsafspraken	n.v.t.
VZVZ Opvragen Verstrekkingsverzoeken	n.v.t.

Nictiz Parameter	Toedieningsperiode
Nictiz Omschrijving	In welke periode zijn de medicatietoedieningen gedaan die worden gevraagd? Opgeleverd worden alle medicatietoedieningen waarvan de datum binnen de hier gespecificeerde periode valt.
Description	In what period were the requested medication administrations carried out? All medication administrations with a date within the specified period will be produced.
FHIR search parameter	effective-time
AoF $get-aorta-data parameter	effective-time
HL7v3	ToedieningsPeriode
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| PeriodOfUse - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	ToedieningsPeriode
VZVZ Opvragen Doseerschema	n.v.t.
VZVZ Opvragen Medicatieafspraken	n.v.t.
VZVZ Opvragen Medicatiegebruik	n.v.t.
VZVZ Opvragen Medicatieverstrekkingen	n.v.t.
VZVZ Opvragen Toedieningen	ToedieningsPeriode
VZVZ Opvragen Toedieningsafspraken	n.v.t.
VZVZ Opvragen Verstrekkingsverzoeken	n.v.t.

Nictiz Parameter	LaatsteStop=TRUE
Nictiz Omschrijving	De laatste eigen stop-Medicatieafspraken, stop-Toedieningsafspraken en stop-WisselendDoseerschema’s op basis van de meest recente RegistratieDatumTijd (onafhankelijk van de Gebruiksperiode) per MedicamenteuzeBehandeling van een specifieke patiënt in het bronsysteem. Deze parameter is altijd onderdeel van de query.
Description	The latest own stop-MedicationAgreements, stop-AdministrationAgreements and stop-VariableDosingRegimens based on the most recent RegistrationDateTime (independent of other PeriodOfUse) per PharmaceuticalTreatment of a specific patient in the source system. This QueryParameter is always part of the query.
FHIR search parameter	With operation $latest-stops
AoF $get-aorta-data parameter	not supported
HL7v3	TBD
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| MpLatestStops - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	n.v.t.
VZVZ Opvragen Doseerschema	LaatsteStop=TRUE; Custom search behaviour for latest stops.
VZVZ Opvragen Medicatieafspraken	LaatsteStop=TRUE; Custom search behaviour for latest stops
VZVZ Opvragen Medicatiegebruik	n.v.t.
VZVZ Opvragen Medicatieverstrekkingen	n.v.t.
VZVZ Opvragen Toedieningen	n.v.t.
VZVZ Opvragen Toedieningsafspraken	LaatsteStop=TRUE; Custom behaviour for latest stops
VZVZ Opvragen Verstrekkingsverzoeken	n.v.t.

Nictiz Parameter	LaatsteStop=FALSE or Empty
Nictiz Omschrijving	Normaal zoek gedrag
Description	Normal search behaviour
FHIR search parameter	Without operation $latest-stops
AoF $get-aorta-data parameter	n.v.t.
HL7v3	TBD
FHIR search parameter profile	nictiz.fhir.nl.r4.medicationprocess9 \| MpLatestStops - SIMPLIFIER.NET
VZVZ Generieke Geparameteriseerde Query Zorggegevens	n.v.t.
VZVZ Opvragen Doseerschema	LaatsteStop=FALSE or LaatsteStop=nil
VZVZ Opvragen Medicatieafspraken	LaatsteStop=FALSE or LaatsteStop=nil
VZVZ Opvragen Medicatiegebruik	n.v.t.
VZVZ Opvragen Medicatieverstrekkingen	n.v.t.
VZVZ Opvragen Toedieningen	n.v.t.
VZVZ Opvragen Toedieningsafspraken	LaatsteStop=FALSE or LaatsteStop=nil
VZVZ Opvragen Verstrekkingsverzoeken	n.v.t.