Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added paragraph 'Dataset constraints are transaction specific'

...

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue

Dit is een sjabloon voor de Developer Guide. Alle instructies staan in een Note panel (paars). Voorbeelden worden cursief weergegeven.

De instructies worden in het Nederlands gegeven, maar de uiteindelijke tekst van de Developer Guide is in het Engels. Engels is Amerikaans Engels.

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue

Version

note

Deze sectie bevat informatie over het document zelf. Zoals versie informatie en een change log

Deze sectie bevat informatie over het document zelf. Zoals versie informatie en een change log

Date

Status

Version

Remarks

Author(s)

Draft

0.0.1

First draft

VZVZ

Draft

0.0.1

Added essential information on VZVZ deviations from Nictiz specs

Added TODOs

Added reference links

v1

1.0

Aanpassingen nictiz URLs

Added paragraph 'Dataset constraints are transaction specific'

Changelog

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
note

Beschrijf globaal in het Engels wat er in deze versie is veranderd t.o.v. de vorige versie.

Hanteer de volgende indeling:

  • H3 kopje ‘Version’ gevolgd door het versienummer

  • H4 kopje ‘Fixed’ met daaronder als bullet list voor elke fix het Jira issue nummer dat geleid heeft tot deze fix en daar achter een korte omschrijving van de fix

  • H4 kopje ‘New’ met daaronder als bullet list voor elke nieuwe toevoeging het Jira issue nummer dat geleid heeft tot deze toevoeging en daar achter een korte omschrijving van de toevoeging

Beschrijf globaal in het Engels wat er in deze versie is veranderd t.o.v. de vorige versie.

Hanteer de volgende indeling:

  • H3 kopje ‘Version’ gevolgd door het versienummer

  • H4 kopje ‘Fixed’ met daaronder als bullet list voor elke fix het Jira issue nummer dat geleid heeft tot deze fix en daar achter een korte omschrijving van de fix

  • H4 kopje ‘New’ met daaronder als bullet list voor elke nieuwe toevoeging het Jira issue nummer dat geleid heeft tot deze toevoeging en daar achter een korte omschrijving van de toevoeging

...

View file
nameVerzamelbestand VZVZ applicatie interfaces richting AORTA.xlsx

Individual use cases

...

Dataset constraints are transaction specific

Note

The dataset needs to adhere to the constraints set by the transaction

Per transaction in the data model in ART DECOR, in the Condition column, refinements are found on attributes. The implementation needs to adhere to these.
These refinements are often the same for all transactions, but sometimes they differ per transaction.
For example, when sending a prescription, there are some fields that are not needed in the prescription and therefore we do not expect them in the prescription. However, when you request and provide medication data, those fields would be included. There are small discrepancies between what is transmitted in one transaction and another.

The advice is to build the building blocks in such a way that you can hide or include attributes in that building block depending on the interaction.
This is also future-proof if you need to move to a newer version of FHIR or other transport protocols.

As implementor, the differences will become apparent, when you Compare transactions side by side.
On big difference is between prescription and medication agreement.

  • The phone number is mandatory when sending a prescription, but it must not be included when making a medication agreement available (important - we also qualify on this).

  • The VV relationship to MA (1-) on (0-) depends on the migration.

The information per transaction can be found under: Dataset: mp- DECOR-samenvatting (Data Elements, Codes, OID's en Rules) in the ZorgView column!

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue

Added for [MVALPHARMAHIS-37] Afwijkingen bouwstenen per interactie - BITS

Individual use cases

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
note

Voeg hier algemene afwijkingen toe t.o.v. de Nictiz use cases

Zet hieronder een overzicht van de beschikbare use cases, een link naar de Nictiz versie en eventueel een aanvulling van de afwijkingen die specifiek zijn voor die use case. Verwijs zo nodig naar andere lokaties. Voorkom dubbel opschrijven.

Voeg hier algemene afwijkingen toe t.o.v. de Nictiz use cases

Zet hieronder een overzicht van de beschikbare use cases, een link naar de Nictiz versie en eventueel een aanvulling van de afwijkingen die specifiek zijn voor die use case. Verwijs zo nodig naar andere lokaties. Voorkom dubbel opschrijven.

...

VZVZ implementeert lab Observations als open-world extension boven op mp-MedicationPrescription-Bundleextension boven op nictiz.fhir.nl.r4.medicationprocess9 | mp MedicationPrescription Bundle - SIMPLIFIER.NET.

Security

Wij hebben een security requirement en daarom is het nodig om een access token te verkrijgen dat meegestuurd wordt naar bronsystemen. Dit verandert niets aan de FHIR-search, maar wel de HTTP call.

...

MP9 search parameter

Description

FHIR search parameter

Nictiz

VZVA (AoF)

PatientIdentificationNumber

Search on patient.

patient.identifier [2]

subject:Patient.identifier [2]

NOT supported on argument line

is part of context

Identification

Search on identifier.

identifier

Code Block
GET [base]/MedicationRequest?identifier=http://example.nl/fhir/NamingSystem/MedicationRequest|999922448

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 [3]

Code Block
GET [base]/MedicationRequest?pharmaceutical-treatment-identifier=http://example.nl/fhir/NamingSystem/pharmaceuticaltreatment|1247848

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 [3]

Retrieves all MedicationRequest resources that represent the building block MedicationAgreement.

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

Retrieves all MedicationRequest resources that represent the building block DispenseRequest.

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

Retrieves all MedicationRequest resources that represent the building block VariableDosingRegimen.

Code Block
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.

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

Retrieves all MedicationDispense resources that represent the building block AdministrationAgreement.

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

Supported

Retrieves all MedicationStatement resources that represent the building block MedicationUse2.

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

Supported

Retrieves all MedicationAdministration resources that represent the building block MedicationAdministration2.

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

Supported

MedicationCode

Search on medication code.

medication.code[4]

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[3]

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 arec are implicit and automatically added by VZVZ based on agreements with Nictiz.

...

The current focus is on reliability and efficiency over additional functionality.
The receiving party may use the Zorg-AB to obtain a user-friendly-name displayname.

...

Project/package

Description

Nictiz R4 MedicationProcess

The profiles and examples related to MO

AoF

link naar de scrollhelp pagina met alle AORTA-profielen

...

AORTA specifications: see all the links combined in the AORTA 2024.1 release AoF Releases as ‘AoF Release’ with label “AoF.2024.1” (Functionaliteit die nodig is voor de kickstart MO).

The various calls on the various API’s adhere to naming conventions by Nictiz and VZVZ.

...

Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
note

Benodigde configurations, waarbij elke bullet point bij voorkeur embedded wordt opgenomen:

  • Aansluiten op testomgevingen (referentie aansluitformulier)

  • Endpoints (test)omgevingen POC - PTO2 - XTO1 (meer?)

  • Autorisatie omgevingen (UZI middelen)

  • Testdata

  • Certificaten x.509

Voeg hier ook informatie m.b.t. de validatietools toe. Zie ook MEDVEILIG-177System Jiraaf1aa7de-fede-31f8-ae91-0deac6bac210System JiraMEDVEILIG-177 voor links

Benodigde configurations, waarbij elke bullet point bij voorkeur embedded wordt opgenomen:

  • Aansluiten op testomgevingen (referentie aansluitformulier)

  • Endpoints (test)omgevingen POC - PTO2 - XTO1 (meer?)

  • Autorisatie omgevingen (UZI middelen)

  • Testdata

  • Certificaten x.509

Voeg hier ook informatie m.b.t. de validatietools toe. Zie ook MEDVEILIG-177 - Issue details worden opgehaald... STATUS voor links

...