...
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Beschrijf globaal in het Engels wat er in deze versie is veranderd t.o.v. de vorige versie. Hanteer de volgende indeling:
|
Version 0.0.1
First draft
...
Introduction
...
Purpose
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Korte beschrijving van de scope van dit document. |
...
| Excerpt |
|---|
The purpose of this document is |
...
to support the implementation of the Healthcare Application Medicatieoverdracht on the AORTA-LSP infrastructure. |
...
Scope
Glossary
Requirements (Programma van eisen)
The list of requirements for the healthcare application addressed in this Developer Guide can be found here:
verwijzing naar de betreffende PvE → inline link
Programma van Eisen Medicatieoverdracht
Use cases (functional use cases)
Als de use cases intern binnen VZVZ beschreven zijn (dus Confluence), dan een include, dus embedded binnen de pagina
Bronnen hiervoor kunnen zijn: PSA, Functioneel Ontwerp
Als de use cases extern aangeboden zijn, dan een inline link naar de documentatie
Bron hiervoor kan bijvoorbeeld zijn Nictiz
Boven de link ook een begeleidende tekst waarin duidelijk gemaakt is wat de link betreft, zodat bij een dode link alsnog een aanknopingspunt is.
Vermijd om de use cases hier uit te schrijven, want dat is foutgevoelig. Hanteer een single point of truth.
The use cases were assembled in cooperation with Nictiz. For the Healthcare Application Medicatieoverdracht the following use cases are relevant and can be found on the Nictiz website or in the PSA which is developed internally.
Purpose of the document
Platte tekst, dus geen verwijzing.
The purpose of this document is to support developers, product owners and architects in the implementation to of the Healthcare Application Medicatieoverdracht.
This document gives a technical overview of the Healthcare Application with references to other documents with further information. It is intended as a landing page that refers to other locations with further information.
This document contains
the system architecture to indicate how this Healthcare Application relates to other products
information on the available APIs
relevant policies and governance that must be adhered to to be able to use this Healthcare Application
information regarding the configuration of the Healthcare Application, such as connection details for the test and acceptance environments
an overview of common and known issues
contact information
Intended audience
The intended audience of this document are developers, product owners and architects of the vendors of EHR and related systems that want to implement connection to the Healthcare Application described in this Developer Guide.
Platte tekst, dus geen verwijzing.
Formuleer hier in de template een standaard tekst, omdat de doelgroep voor een dev guide bijna altijd hetzelfde is. Zie voorstel hierboven.
Related documents
Hier een opsomming van relevante documenten, met onderstaande voorkeuren in prio:
Inline externe link
Toevoegen van bijlagen (ZIP, i.v.m. compatibiliteit).
Lijst met links moet een beschrijving bevatten zodat duidelijk is waar de link over gaat.
NB. Afspraak is dat alle links zoals in dit document hier bij elkaar gezet worden en aangevuld worden met andere relevante documenten.
This section contains a list of all the links from other sections of this document as well as links to other relevant documents.
links to requirements from government or relevant national and European standards
NEN
WEGIZ
Product Documentation Versioning
Dit is een verwijzing naar de versie van de documentatie waarnaar verwezen wordt.
Geef alleen de Major-Minor versie van het gerefereerde document
UPDATE 2024-11-12: mogelijk is deze sectie niet van belang.
- Aanvullen met informatie uit Doel Belangrijke documenten en achtergrond informatie
...
Document
...
Document Version
...
vb: AoF specificaties
...
2024.1
...
AORTA
...
...
Nictiz FO
Architecture
Context
repo = Confluence space nodig waarvandaan wordt gerefereerd.
Voor de diagrammen wordt er gerefereerd vanuit een eerdere uitwerkingen vanuit een repository. Aan de hand van de uitwerkingen in de PvE dienen afspraken gemaakt te worden over de uitwerkingen conform de uitwerkingen in de repo.
Bij de diagrammen ook toelichting bij de platen
Korte uitleg
It should be possible to exchange information regarding medication between healthcare providers and between healthcare providers and consumers.
The Healthcare Application Medicatieoverdracht consists of three parts:
content-related specifications as defined by the Nictiz project team
updates to these specifications as defined by the VZVZ project team to allow the exchange to happen on the AORTA infrastructure
infrastructural specifications as defined by the VZVZ AORTA team to allow conformance to the AORTA infrastructure
This application layer architecture is related to the higher business layer architecture as formulated in Architectuur.
Context diagram
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Hier komt een tabel met Nederlandse en Engelse termen met uitleg. Onderstaande tabel kan gebruikt en aangevuld worden met specifieke termen die in deze Developer Guide gebruikt worden.
|
...
Term (English)
...
(Dutch)
...
Definition
...
Consumer
...
Burger
...
Subject of an action regarding the health or wellbeing of the subject. This might be a patient or client but can be broader that that.
(src ChatGPT) Consumer – This term is used in healthcare to refer to someone who engages with healthcare services, products, or information in a more general sense.
...
Personal Health Record (PHR)
...
PGO
...
An application where a person/consumer can request access to his or her own medical information stored in the EHR systems of the healthcare providers.
...
Vaccination
...
Vaccinatie
...
Healthcare Provider
...
Zorgaanbieder
...
The organization that provides healthcare to patients or consumers.
...
Healthcare Provider
...
Zorgverlener
...
The person that provides healthcare to patients or consumers. The context should provide the indication whether the English term refers to the organization or the person.
...
Mitz
...
Mitz
...
Dutch centralized patient consent registry.
...
Transfer record
...
Overdrachtsdossier
...
The patient record to be transferred from one healthcare provider to another. This transfer implies transfer of responsibility for the record.
...
Expiration date
...
Houdbaarheidsdatum
...
Healthcare Application
...
Zorgtoepassing
...
The implementation, both application and process, that supports healthcare providers in their treatment of patients.
TODO Controleer de definitie zoals die in de architectuurboard is afgesproken.
...
Referral
...
Verwijzing
...
The act of referring a patient to a different healthcare provider for further treatment.
Platte tekst, dus geen verwijzing. |
This document gives a technical overview of the Healthcare Application with references to other documents with further information. It is intended as a landing page that refers to other locations with further information.
This document contains
the system architecture to indicate how this Healthcare Application relates to other products
information on the available APIs
relevant policies and governance that must be adhered to to be able to use this Healthcare Application
information regarding the configuration of the Healthcare Application, such as connection details for the test and acceptance environments
an overview of common and known issues
contact information
Intended audience
This document is intended for developers, product owners and architects of XIS-system development and integration.
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Platte tekst, dus geen verwijzing. Formuleer hier in de template een standaard tekst, omdat de doelgroep voor een dev guide bijna altijd hetzelfde is. Zie voorstel hierboven. |
References
Glossary
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Hier komt een tabel met Nederlandse en Engelse termen met uitleg. Onderstaande tabel kan gebruikt en aangevuld worden met specifieke termen die in deze Developer Guide gebruikt worden.
|
Term (English) | (Dutch) | Definition |
|---|---|---|
Medication agreement | Medicatieafspraak | 'Medicatieafspraak / Medication agreement/ is the prescriber’s proposal for medication use with which the patient agrees. An agreement to discontinue medication is also an MA. |
Variable dosing regimen | Wisselend doseerschema | 'Wisselend doseerschema / Variable dosing regimen' contains the dosing instruction as composed by an (external) prescriber. In the WDS the element 'instructions for use' from the MA is further specified. The WDS can be modified without changing the MA. |
Dispense request | Verstrekkingsverzoek | 'Verstrekkingsverzoek / Dispense request' is the request from a prescriber to a pharmacist to supply the patient with one or more medicinal products in support of the current MA(s) |
Administration agreement | Toedieningsafspraak | 'Toedieningsafspraak / Administration agreement' contains the instructions for medication use (or administration) from the pharmacist to the patient (or his representative or administrator), adding to the MA. |
Medication dispense | Medicatieverstrekking | 'Medicatieverstrekking / Medication dispense' is the provision of a supply of medicinal product to the patient or his administrator or representative. |
Medication administration | Medicatietoediening | 'Medicatietoediening / Medication administration' is the registration of individual administrations of the medicinal product to the patient by the person who administers them (such as a nurse or the patient himself) in relation to the agreements made. |
Medication use | Medicatiegebruik | 'Medicatiegebruik / Medication use' is a statement about historical, current or intended use of a medicinal product. |
Proposal medication agreement | Voorstel medicatieafspraak | 'Voorstel medicatieafspraak / Proposal medication agreement' is a recommendation or request from the pharmacist, prescriber or the administrator to the prescriber of the MA about the medication agreed upon. The recommendation request may include evaluating, discontinuing, starting or modifying medication. |
Reply proposal medication agreement | Antwoord voorstel medicatieafspraak | 'Antwoord voorstel medicatieafspraak / Reply proposal medication agreement' is a reply from the prescriber to the VMA. |
Proposal dispense request | Voorstel verstrekkingsverzoek | 'Voorstel verstrekkingsverzoek / Proposal dispense request' is a proposal from the pharmacist to the prescriber to approve one or more MVE(s) in support of the current MA(s). This is comparable with the current situation of submitting the authorisation form or combined prescription or submitting a repeat prescription for signing. The patient may also submit a VVV to the prescriber. |
Reply proposal dispense request | Antwoord voorstel verstrekkingsverzoek | 'Antwoord voorstel verstrekkingsverzoek / Reply proposal dispense request' is a reply from the prescriber to the VVV. |
Clinical Information Model (CIM) | zorginformatiebouwsteen (ZIB) | See Clinical Building Block (CBB) |
Clinical Building Block (CBB) | zorginformatiebouwsteen (ZIB) | Related data elements are grouped together in a Clinical Information Model (CIM) |
Therapeutic and logistical building blocks | Therapeutische en logistieke bouwstenen | The model is designed in such a way that therapeutic building blocks and logistical building blocks are separated from each other. |
Pharmaceutical treatment | Medicamenteuze behandeling | 'Pharmaceutical treatment' is a technical concept in the information standard. Its purpose is:
|
Product Overview
Requirements (Programma van eisen)
The list of requirements for the healthcare application addressed in this Developer Guide can be found here:
| Page Properties | ||||
|---|---|---|---|---|
| ||||
|
Programma van Eisen Medicatieoverdracht
Use cases (functional use cases)
| Page Properties | ||||
|---|---|---|---|---|
| ||||
|
The use cases were refined in cooperation with Nictiz. For the Healthcare Application Medicatieoverdracht the following use cases are relevant and can be found on the Nictiz website or in the PSA which is developed internally.
Related documents
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Hier een opsomming van relevante documenten, met onderstaande voorkeuren in prio:
Lijst met links moet een beschrijving bevatten zodat duidelijk is waar de link over gaat. NB. Afspraak is dat alle links zoals in dit document hier bij elkaar gezet worden en aangevuld worden met andere relevante documenten. List
|
This section contains a list of all the links from other sections of this document as well as links to other relevant documents.
The overview lists:
Requirements
Functional Designs
Technical Designs
Standards and Regulations
Architecture
Context
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Korte uitleg |
Vision:
The Medication Transfer program works on good, complete electronic transfer of medication data. For an up-to-date and complete medication overview for every healthcare provider and every patient. A basic set of medication data has been agreed in the Guideline for Transfer of Medication Data in the Chain. These basic data must be available to every healthcare provider who prescribes, provides or administers. Three information standards enable the registration and exchange of this basic set. These are the information standards Medication Process, Lab values for medication and CiO (Contraindications and hypersensitivities). The healthcare-wide implementation of the guideline and the associated information standards takes place within the Medication Transfer program. New agreements and procedures make network and chain care possible; the information standards included in software packages make digital data exchange possible.
Objectives:
The Medication process program aims first to take away existing obstacles in the medication process, while taking into account current legislation and the possibility of obtaining tangible results in the foreseeable future.
Architecture:
The Healthcare Application Medicatieoverdracht consists of various parts:
business layer architecture by Nictiz
Information standards
functional requirements
information models
application layer architecture by VZVZ
application requirements
information models for data exchange on AORTA-LSP infrastructure
infrastructure integration specifications with centralized application services
This application layer architecture is related to the higher business layer architecture as formulated in Architectuur.
Terminology:
| Note |
|---|
AORTA 8 - Subscribe and notify The terms; subscribe and notify need to be used instead of the legacy terms; signal, event and register. In the AORTA v3 architecture the legacy terms are still present. |
Context diagram
| Page Properties | ||||
|---|---|---|---|---|
| ||||
Verplicht
|
...
- Aanvullen met informatie van Architectuur Bedrijfsprocessen MO
| Note |
|---|
Terminologie overgang in AORTA 8 Abonneren Notificeren is de nieuwe naamgeving. In AORTA v3 architectuur is soms de oude naamgeving nog van kracht. Registreren Abonnement en Signaal bij Gebeurtenis. |
Flow chart
|
Zie Architectuur
Flow chart
| Page Properties | ||||
|---|---|---|---|---|
| ||||
|
- Aanvullen met informatie van transacties en interfaces en verzamelbestand links
...
This section covers all available use cases as defined by Nictiz and the changes to the specfications as required by this Healthcare Application.
| Page Properties | ||||
|---|---|---|---|---|
| ||||
|
Which use cases should I support
The Healthcare Application Medicatieoverdracht is very large and covers all use cases for every type of EHR system that participates. The list below indicates which use cases should be supported by each type of system. This allows vendors to drill down to only support the relevant use cases.
...
- Aanvullen met informatie van transacties per systeem rol en interfaces en verzamelbestand
The roles and use-cases are summarized by Nictiz and the Program in Verzamelbestand met functionele, technische en infrastructurele documentatie Medicatieproces 9 t.b.v. Kickstart - informatiestandaarden.
...
| View file | ||
|---|---|---|
|
...
|
Individual use cases
| Page Properties | ||||
|---|---|---|---|---|
| ||||
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. |
MP-MGR MP-MGB proxy-facade
...
MP9 search parameter | Description | FHIR search parameter | Nictiz | VZVA (AoF) | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
PatientIdentificationNumber | Search on patient. |
| NOT supported on argument line is part of context | |||||||
Identification | Search on identifier. |
| GET [base]/MedicationRequest?identifier=http://example.nl/fhir/NamingSystem/MedicationRequest|999922448 | Supported via GET [base] $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. |
| GET [base]/MedicationRequest?pharmaceutical-treatment-identifier=http://example.nl/fhir/NamingSystem/pharmaceuticaltreatment|1247848 | Supported via GET [base] $get-aorta-data? &therapy-identifier=<http://example.nl/fhir/NamingSystem/pharmaceuticaltreatment|<id> | ||||||
Type | Search on type of medication building block. |
| Retrieves all MedicationRequest resources that represent the building block MedicationAgreement.
Retrieves all MedicationRequest resources that represent the building block DispenseRequest.
Retrieves all MedicationRequest resources that represent the building block VariableDosingRegimen.
| Supported via GET [base] as &category=http://snomed.info/sct|<category> | ||||||
Retrieves all MedicationDispense resources that represent the building block MedicationDispense.
Retrieves all MedicationDispense resources that represent the building block AdministrationAgreement.
| Supported | |||||||||
Retrieves all MedicationStatement resources that represent the building block MedicationUse2.
| Supported | |||||||||
Retrieves all MedicationAdministration resources that represent the building block MedicationAdministration2.
| Supported | |||||||||
MedicationCode | Search on 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. |
| Supported via effective-time as GebruiksPeriode GET [base] | |||||||
DispensePeriod | Returns all medication dispenses within the specified time period. |
| Supported via effective-time as VerstrekkingsPeriode GET [base] | |||||||
AdministrationPeriod | Returns all medication administrations within the specified time period. |
| Supported via effective-time as ToedieningsPeriode GET [base] | |||||||
- | 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. |
| Not Supported via arguments! Includes arec implicit and automatically added by VZVZ based on agreements with Nictiz. |
Provenance Resources in FHIR response bundles
Also see Architectuur for the functional description of Provenance.
...
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.
Sequence diagrams
| Page Properties | ||||
|---|---|---|---|---|
| ||||
|
...
|
See DECOR informatie voor project: Medicatieproces (mp-) for Business Layer scenarios
See DECOR informatie voor project: Medicatieproces op LSP (mp-vzvz-) Medicatieproces op het LSP versie 1.5 en is gebaseerd op MP9 3.0.0-beta.4 HTML for Application Layer scenarios
See https://aorta-on-fhir.scrollhelp.site/aorta-on-fhir-specificaties/latest/sequence-diagrammen for AORTA-on-FHIR platform integrations.
See Uitwerking usecases VGU en abonneren en notificeren
Class diagrams
- Toevoegen databoom-structuren voor BTD verwerking middels includes.
- Toevoegen link naar contextcode definities
...
| Page Properties | |||||
|---|---|---|---|---|---|
Voorbeeld:
|
...
|
- Toevoegen databoom-structuren voor BTD verwerking middels includes.
Zie Raadpleging en Abonnement - Contexten
Zie ook Architectuur
Available APIs
See DECOR informatie voor project: Medicatieproces op LSP (mp-vzvz-) Medicatieproces op het LSP versie 1.5 en is gebaseerd op MP9 3.0.0-beta.4 XML for HL7 v3 SOAP interactions
See FHIR Implementation Guide Medication Process 9 version 3.0.0-beta.4 - informatiestandaarden for FHIR integration
V3 messages and packages
FHIR profiles and packages
...