PatientIdentificationNumber

Search on patient.

patient.identifier

subject:Patient.identifier

NOT supported on argument line

is part of context

Identification

Search on identifier.

identifier

Supported via

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

https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/Working-versionlatest/use-cases-resource-broker-v3-in#UseCasesResourceBrokerv3-in-Transformatiegeneriekeparametersnaarinteractie-specifiekeparameters

$get-aorta-data?

&instance-identifier=<http://example.nl/fhir/NamingSystem/MedicationRequest|<id>

Identification

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.

pharmaceutical-treatment-identifier

Supported via

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

https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/Working-versionlatest/use-cases-resource-broker-v3-in#UseCasesResourceBrokerv3-in-Transformatiegeneriekeparametersnaarinteractie-specifiekeparameters

$get-aorta-data?

&therapy-identifier=<http://example.nl/fhir/NamingSystem/pharmaceuticaltreatment|<id>

Type

Search on type of medication building block.

category

Retrieves all MedicationRequest resources that represent the building block MedicationAgreement.

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

Retrieves all MedicationRequest resources that represent the building block DispenseRequest.

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

Retrieves all MedicationRequest resources that represent the building block VariableDosingRegimen.

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

Supported via

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

as

&category=http://snomed.info/sct|<category>

Retrieves all MedicationDispense resources that represent the building block MedicationDispense.

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

Retrieves all MedicationDispense resources that represent the building block AdministrationAgreement.

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

Supported

Retrieves all MedicationStatement resources that represent the building block MedicationUse2.

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

Supported

Retrieves all MedicationAdministration resources that represent the building block MedicationAdministration2.

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

Supported

MedicationCode

Search on medication code.

medication.code

NOT SUPPORTED?

PeriodOfUse

Search on the MedicationAgreement, VariableDosingRegimen, AdministrationAgreement and MedicationUse2 building blocks that are related to medication that was used, is used or will be used during the indicated period.

Whenever a search is done on the MedicationAgreement, VariableDosingRegimen or AdministrationAgreement building blocks it is required to also include the latest stopped building blocks of that kind within each pharmaceutical treatment, even if these have a period of use outside the PeriodOfUse that is being searched on.

period-of-use

Supported via effective-time as GebruiksPeriode

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

https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/Working-versionlatest/use-cases-resource-broker-v3-in#UseCasesResourceBrokerv3-in-Transformatiegeneriekeparametersnaarinteractie-specifiekeparameters

DispensePeriod

Returns all medication dispenses within the specified time period.

whenhandedover

Supported via effective-time as VerstrekkingsPeriode

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

https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/Working-versionlatest/use-cases-resource-broker-v3-in#UseCasesResourceBrokerv3-in-Transformatiegeneriekeparametersnaarinteractie-specifiekeparameters

AdministrationPeriod

Returns all medication administrations within the specified time period.

effective-time

Supported via effective-time as ToedieningsPeriode

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

https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/Working-versionlatest/use-cases-resource-broker-v3-in#UseCasesResourceBrokerv3-in-Transformatiegeneriekeparametersnaarinteractie-specifiekeparameters

-

The client may request that the server returns resources related to the search results, in order to reduce the overall network delay of repeated retrievals of related resources.

Supporting the include of the Patient and Medication resources referenced by building blocks is required. Others (Organization, Location, PractitionerRole, Practitioner, RelatedPerson, Observation) are optional. However: all resources referenced per literal reference SHALL be resolvable per the Nictiz IG.

_include=[type]:patient

_include=[type]:medication

Not Supported via arguments!

Includes are implicit and automatically added by VZVZ based on agreements with Nictiz.