Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added details on Provenance logic

...

Numberedheadings
number-formatdecimal
skip-headings
start-numbering-with1
h1
h2
h3
h4
h5
h6
enabledtrue
start-numbering-atH1
add-anchorsfalse

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)

1

Draft

0.0.1

First draft

VZVZ

2

Draft

0.0.1

Added essential information on VZVZ deviations from Nictiz specs

Added TODOs

Added reference links

3

4

Changelog

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

Version 0.0.1

First draft

Product Overview

Introduction

note

Korte beschrijving van de scope van dit document.

Korte beschrijving van de scope van dit document.

This document is intended for developers who want to implement the MedicatieOverdracht Healthcare application on the AORTA infrastructure

References

Glossary

note

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.

159 159 incomplete TODO de termen en de omschrijvingen moeten nog gecontroleerd worden op correctheid. 160 160 incomplete TODO termen en omschrijvingen aanvullen met MO-specifieke termen cq verwijzen naar beschrijvingen van die termen

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.

  • TODO de termen en de omschrijvingen moeten nog gecontroleerd worden op correctheid.
  • TODO termen en omschrijvingen aanvullen met MO-specifieke termen cq verwijzen naar beschrijvingen van die termen

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.

Requirements (Programma van eisen)

The list of requirements for the healthcare application addressed in this Developer Guide can be found here:

note
  • verwijzing naar de betreffende PvE → inline link

  • verwijzing naar de betreffende PvE → inline link

Programma van Eisen Medicatieoverdracht

Use cases (functional use cases)

note
  • 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.

  • 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

note

Platte tekst, dus geen verwijzing.

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.

note

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.

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

note

Hier een opsomming van relevante documenten, met onderstaande voorkeuren in prio:

  1. Inline externe link

  2. 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.

Hier een opsomming van relevante documenten, met onderstaande voorkeuren in prio:

  1. Inline externe link

  2. 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.

Product Documentation Versioning

note

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.

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.

161 161 incomplete

Document

Document Version

 vb: AoF specificaties

2024.1

 AORTA

 

Nictiz FO

Architecture

Context

note
  • 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

  • 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

note

Korte uitleg

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

note

Verplicht
Plaat met daaronder de beschrijving.

  • Context diagram (UML/businesslaag van Archimate) → relatie met de buitenwereld moet helder zijn. Relatie met de andere actoren.

Verplicht
Plaat met daaronder de beschrijving.

  • Context diagram (UML/businesslaag van Archimate) → relatie met de buitenwereld moet helder zijn. Relatie met de andere actoren.

162 162 incomplete Aanvullen met informatie van Architectuur Bedrijfsprocessen MO

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

note
  • Verplicht

  • business niveau

  • Verplicht

  • business niveau

163 163 incomplete Aanvullen met informatie van transacties en interfaces en verzamelbestand links

Use cases

This section covers all available use cases as defined by Nictiz and the changes to the specfications as required by this Healthcare Application.

note
  • Verplicht

  • korte omschrijving, referentie naar de technische use cases

  • bij voorkeur embedden, indien niet mogelijk dan extern linken of bijlagen toevoegen (zip). Dit laatste alleen in uiterste nood.

  • Verplicht

  • korte omschrijving, referentie naar de technische use cases

  • bij voorkeur embedden, indien niet mogelijk dan extern linken of bijlagen toevoegen (zip). Dit laatste alleen in uiterste nood.

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.

note

Neem hier de kruisjestabel van Tjerk op of geef een link naar de locatie waar die staat

Neem hier de kruisjestabel van Tjerk op of geef een link naar de locatie waar die staat

164 164 incomplete 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.

Usecases & Processen contains additional business analysis by VZVZ.

Verzamelbestand VZVZ applicatie interfaces richting AORTA

Hier volgt een uitgebreide toelichting op het Verzamelbestand informatiestandaarden, zoals te vinden op de (Kickstart) Medicatieoverdracht - Landingspagina documentatie leveranciers - informatiestandaarden

Dit uitgebreide verzamelbestand bevat informatie over:

  • VZVZ AoF BGx-Systeemrol (platformgeneriek voor FHIR)

  • VZVZ AORTA FHIR Systeemrol (specifiek voor zorgtoepassingen binnen FHIR)

  • VZVZ AORTA v3 Applicatiesysteemrol (specifiek voor zorgtoepassingen binnen v3)

Deze uitleg biedt ondersteuning bij de implementatie van de vereisten voor elke benodigde rol.

Individual use cases

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.

MP-MGR MP-MGB proxy-facade

AORTA acts as proxy-facade towards the source systems. The calls from a MP-MGR are distributed towards MP-MGB servers and the responses are aggregated as bundled response.

We hanteren een generieke query (in FHIR in de vorm van een $get-aorta-data operation) voor vragende systemen, die door AORTA wordt omgezet naar FHIR searches (minus BSN) naar bronsystemen.

MP-MGR MP-MGB FHIR includes

AORTA ensures that all relevant data is requested in a minimum number of requests. This avoids unnecessary round-trips, and ensures sufficient data retrieval to allow for the BTD to transform data between exchange formats.

These includes result in explicitely broadend FHIR searches with _include and _include:iterate parameters towards MP-MGB.

Patient identifier not part of argument but part of context

Patient identifier is not intended to be mentioned in the query parameters. This would impose a security risk.

Om security redenen nemen wij het BSN niet op in de URL van FHIR searches. Het is onderdeel van het token dat wordt meegestuurd (dat dus niet alleen autorisatiehulpmiddel is maar ook gegevensdrager).

The patient indentifier needs to be communicated via the access-token.

This design-pattern is used for incoming as well as outgoing traffic on AORTA-LSP.

AORTA-LSP does NOT support patient identification with the use of search parameters.

As mentioned in FHIR Implementation Guide Medication Process 9 version 3.0.0-beta.3 - informatiestandaarden - Patient_identification

Within AORTA, each transaction is performed in the context of a specific patient, whose context might has been established using the authentication mechanisms. Patient is part of the token exchange.

Het BSN van de betreffende patient is opgenomen in het access_token.

HTTP argument patient.identifier is NOT supported like

GET [base]/MedicationRequest?
patient.identifier=http://fhir.nl/fhir/NamingSystem/bsn%7C111222333

MP-VOS + LAB-LRS

Sturen verzoek tot medicatieverstrekking van medicatie of verwerking van wijziging in medicatieafspraak.

VZVZ implementeert lab Observations als open-world extension boven op mp-MedicationPrescription-Bundle.

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.

HTTP-Headers

Daarnaast zijn er nog een aantal HTTP-headers die we gebruiken, zoals Content-Type (formaat FHIR-content), AORTA-ID (tracing/logging van interacties/ketens) en AORTA-Version (versie infrastructuur).

Zoals request-id, initial-request-id, etc.

AoF FHIR Search parameter support for generic query using get-aorta-data

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

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-version/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]

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-version/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.

Retrieves all MedicationRequest resources that represent the building block DispenseRequest.

Retrieves all MedicationRequest resources that represent the building block VariableDosingRegimen.

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.

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.

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

Provenance

Also see Architectuur for the functional description of Provenance.

During pull and push exchange, the AORTA-LSP as exchange system adds FHIR Provenance Resources in into the bundles during pull and push exchange to indicate the source systems.

For an example see; vzvz.fhir.aof | aorta-provenance-example-bundle - SIMPLIFIER.NETLogic in AORTA:

Per bundle only one specific Provenance-object is added per source systeem

Per bundle one specific Provenance-object is shared between all resources of the source

In the Provenance object each resource in the searchset bundle is referenced:

  • fullUrl, if the fullUrl is a logical id (urn:uuid)

  • resource.id , if the fullUrl contains an absolute Url

  • Is the source returns a OperationOutcome, and it is not a part of the searchset, than a resource object is created with a logical id, which is referenced from the Provenance-Object

During aggregation of the sources, per source, a Provenance object is maintainted and expanded with the new target.reference(s).

After aggregation the Provenance object(en) are added to the consolidated bundle.

The Provenance objects are also included with regular FHIR search responses, not only during the get-aorta-data operation.

The same logic is being reused.

The Provenance contains the AORTA-app-id and URA to identify the source system.

Note: AORTA-LSP currently does not add user-friendly-name displaynames.

This element is NOT filled:

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

note
  • Verplicht

  • technische niveau

  • Niet alleen de happy flows, maar ook de unhappy alternatieve flows.

  • Eventueel links naar de diagrammen → m.n. die van Ron van Holland m.b.t. de diverse workflows

  • Verplicht

  • technische niveau

  • Niet alleen de happy flows, maar ook de unhappy alternatieve flows.

  • Eventueel links naar de diagrammen → m.n. die van Ron van Holland m.b.t. de diverse workflows

165 165 incomplete Toevoegen scrollhelp links voor Sequence Diagrammen richting AoF en instructies welke flows te implementeren per rol MedMij, FHIR bron/ont. 166 166 incomplete Zie ook abo/not swimlanes in Uitwerking usecases VGU en abonneren en notificeren

Class diagrams

167 167 incomplete Toevoegen databoom-structuren voor BTD verwerking middels includes. 168 168 incomplete Toevoegen link naar contextcode definities

Zie ook Architectuur

note
  • UML

  • embedded vanuit de repository

  • Opnemen indien relevant

  • UML

  • embedded vanuit de repository

  • Opnemen indien relevant

Voorbeeld:

21009571861499581036231Diagram zonder titel-1726576793084.drawio11https://vzvz.atlassian.net/wikiDiagram zonder titel-1726576793084.drawio0911952

Available APIs

V3 messages and packages

FHIR profiles and packages

note

Lijst met links naar de relevante FHIR profielen op Simplifier. Zowel de Nictiz profielen als de VZVZ profielen.

Benoem de FHIR packages die nodig zijn voor deze profielen. Indien het belangrijk is dat een specifieke versie van een bepaald package gebruikt wordt, vermeld dat dan.

Het wordt afgeraden om naar een specifieke versie te verwijzen. Doe dat dus alleen als het echt niet anders kan.

Lijst met links naar de relevante FHIR profielen op Simplifier. Zowel de Nictiz profielen als de VZVZ profielen.

Benoem de FHIR packages die nodig zijn voor deze profielen. Indien het belangrijk is dat een specifieke versie van een bepaald package gebruikt wordt, vermeld dat dan.

Het wordt afgeraden om naar een specifieke versie te verwijzen. Doe dat dus alleen als het echt niet anders kan.

The FHIR profiles used in this Healthcare Application can be found on Simplifier.

Project/package

Description

Nictiz R4 MedicationProcess

The profiles and examples related to MO

AoF

link naar de scrollhelp pagina met alle AORTA-profielen

The Healthcare Application Medicatieoverdracht spans a hybrid situation in which messages can be exchanged in both HL7 v3 and HL7 FHIR. The AORTA infrastructure uses a Transformation Service to transform one type into another so systems only supporting a specific format can still exchange information.

To make this transformation possible without losing valuable information some restrictions to the FHIR implementation are required:

  • ALWAYS make sure the resource instance has a valid business identifier

  • do NOT use absolute FHIR references, they cannot be converted to an HL7 v3 reference

  • ALWAYS add the necessary resources in a bundle, the LSP gateway cannot fetch the additional resources and incomplete bundles (i.e. with referenced resources that are not present in the bundle) can not be transformed.



TODO onderstaande tekst moet gecontroleerd worden (klopt alles en hoe is dit uitgewerkt in de PvE’s e.d.) en zo nodig hierboven herschreven/aangevuld worden.

Omschrijving: Hoe kunnen we tussen medicatiebouwstenen refereren in FHIR in een ecosysteem waarin ook geconverteerd moet worden van en naar HL7v3?

  • In HL7v3 kunnen absolute FHIR referenties niet overgebracht worden en bestaat een referentie uit een business identifier.

  • Bij het converteren van FHIR naar HL7v3 moet de business identifier dus achterhaald kunnen worden, anders verlies je de relatie.

  • Het verliezen van de relatie is niet acceptabel in verband met de afleidingsregels.

  • Op het LSP worden géén REST-calls gedaan om (FHIR-)referenties te kunnen resolven en dus een business identifier te achterhalen bij een absolute of relatieve FHIR URL.

  • Referenties kunnen ook gaan naar een bouwsteen die ‘van’ iemand anders is (een andere zorgaanbieder).

  • Bij een LSP-query mogen andermans bouwstenen niet opgeleverd worden. Hoe kan je dan (bij het antwoord op een query) een referentie resolven die in een FHIR bouwsteen een relatieve URL heeft naar je eigen server zonder een extra REST-call te doen naar die FHIR server?

  • Is het eventueel gewenst om URL’s naar ándere FHIR servers (bij andere zorgaanbieders) in jouw FHIR-bericht op te nemen?

  • Hoe weet je of een andere zorgaanbieder een échte FHIR-server heeft waar deze URL’s resolvable zijn, of wellicht alleen een façade?

In gesprek met Lauri R en Jelmer vd M kwamen we tot de voorzichtige conclusie dat - zo lang we te maken hebben met conversies van/naar HL7v3 - referenties tussen medicatiebouwstenen ook in FHIR altijd via business identifier zouden moeten gaan. Klopt die conclusie?
src: https://nictiz.atlassian.net/browse/MP-1596

Examples

note

Neem hier een lijst op van embedded links naar voorbeeldberichten, bijv. op Simplifier en/of code voorbeelden in GitHub.
NB. de voorbeeldberichten voor AORTA staan per profiel genoemd op de pagina met AORTA-profielen en die van MO staan in Simplifier, volgens mij zonder overzicht

Neem hier een lijst op van embedded links naar voorbeeldberichten, bijv. op Simplifier en/of code voorbeelden in GitHub.
NB. de voorbeeldberichten voor AORTA staan per profiel genoemd op de pagina met AORTA-profielen en die van MO staan in Simplifier, volgens mij zonder overzicht

API specification

note
  • API specificaties van de toepassing

  • beschrijving/visualisatie van de API, volgens industry standard methode → referentie d.m.v. OpenAPI (voorheen Swagger)

    • Swagger werkt met Viewport

    • Swagger is compatible met API’s en SOAP’s

  • API specificaties van de toepassing

  • beschrijving/visualisatie van de API, volgens industry standard methode → referentie d.m.v. OpenAPI (voorheen Swagger)

    • Swagger werkt met Viewport

    • Swagger is compatible met API’s en SOAP’s

AORTA specifications: see all the links combined in the AORTA 2024.1 release

Naamgeving Nictiz

  • Sturend

  • Ontvangend

  • Beschikbaarstellend

  • Raadplegend

  • Voorstel

  • AntwoordVoorstel

Naamgeving AoF

  • ZA Verzendend Systeem

  • ZA Ontvangend Systeem

Naamgeving AORTA v3

  • Webservice

    • Versturen

    • Opvragen

  • Transactierollen

    • xxZ - verzendendsysteem

    • xxD - ontvangendsysteem

    • Vxx - voorstel…

    • Axx - antwoord…

    • xxO - … opvragend systeem

    • xxV - …bronsysteem | …opleverend systeem

Security

note

voor de onderstaande onderdelen een acceptable means of compliance beschrijven.

Verwijs naar de tokens, VGU, etc.

voor de onderstaande onderdelen een acceptable means of compliance beschrijven.

Verwijs naar de tokens, VGU, etc.

Identification and Authorization Management

note
  • ref naar IAM eisen in PvE, embedded

  • verklaring op de eisen en een howto--> uitvragen: op welke manier wil een developer dit

  • ref naar IAM eisen in PvE, embedded

  • verklaring op de eisen en een howto--> uitvragen: op welke manier wil een developer dit

169 169 incomplete Verwijzen naar PvE!

Encryption

note
  • ref naar encryptie eisen in PvE, in embedded

  • verklaring op de eisen en een howto --> uitvragen: op welke manier wil een developer dit

  • ref naar encryptie eisen in PvE, in embedded

  • verklaring op de eisen en een howto --> uitvragen: op welke manier wil een developer dit

170 170 incomplete Verwijzen naar PvE!

Voorbeelden:

Authentication

note
  • ref naar authentication eisen in PvE, embedded

  • verklaring op de eisen en een howto--> uitvragen: op welke manier wil een developer dit

  • Ref naar authenticatie flow, embedded

  • ref naar authentication eisen in PvE, embedded

  • verklaring op de eisen en een howto--> uitvragen: op welke manier wil een developer dit

  • Ref naar authenticatie flow, embedded

Zie Autorisatierichtlijn Medicatieveiligheid | AORTA-LSP

171 171 incomplete Beschrijving hoe dit zich vertaalt in systeemrollen. 172 172 incomplete Beschrijving hoe dit zich vertaalt in middelen zoals UZI, Zorg-ID etc 173 173 incomplete Verwijzen naar PvE!

Voorbeeld:

Configuration

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 https://vzvz.atlassian.net/browse/MEDVEILIG-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 https://vzvz.atlassian.net/browse/MEDVEILIG-177 voor links

Common Issues/Known Issues

note

Known issues is een overzicht waarin de issues zijn opgenomen van veel voorkomende problemen in de praktijk, met daarbij een advies hoe hier mee om te gaan.

Externe inline link naar common- / known issues (bijvoorbeeld in supportal)

Known issues is een overzicht waarin de issues zijn opgenomen van veel voorkomende problemen in de praktijk, met daarbij een advies hoe hier mee om te gaan.

Externe inline link naar common- / known issues (bijvoorbeeld in supportal)

Contact information

note

Contactgegevens

  • Single point of contact (bijvoorbeeld: Product Manager), die verwijst bijvoorbeeld door naar:

    • VZVZ Testteam (vragen over: aansluiting, omgevingsproblemen, acceptatie, testscript)

    • Architectuurteam (vragen over: PvE)

Contactgegevens

  • Single point of contact (bijvoorbeeld: Product Manager), die verwijst bijvoorbeeld door naar:

    • VZVZ Testteam (vragen over: aansluiting, omgevingsproblemen, acceptatie, testscript)

    • Architectuurteam (vragen over: PvE)

Person

Role/Type of questions

Contact

Bart Molenaar

Product Manager

VZVZ Testteam

Questions re connections, acceptations, testscripts

validatie@medicatieoverdracht.nl

VZVZ Architects

Questions re PvE…..

solutionarchitecten@vzvz.nl

174 174 incomplete bedrijfsarchitectuur?

note

Vul hier een link in naar bijv. een service desk of een andere manier om in contact te komen met iemand die geraadpleegd kan worden.

Vermijd namen, email adressen en telefoonnummers omdat een Developer Guide publiekelijk beschikbaar komt op het internet. Voeg alleen links toe naar een omgeving waarop eerst ingelogd moet worden voordat de vragen gesteld kunnen worden. Anders kun je wachten op spam-registraties.


Update 2024-11-12: er is nog geen generieke servicedesk applicatie beschikbaar, dus we ontkomen niet aan email adressen. Misschien moet er dan besloten worden dat alle vragen via het testteam gaan en dat zij ze intern routeren naar de juiste persoon.

Vul hier een link in naar bijv. een service desk of een andere manier om in contact te komen met iemand die geraadpleegd kan worden.

Vermijd namen, email adressen en telefoonnummers omdat een Developer Guide publiekelijk beschikbaar komt op het internet. Voeg alleen links toe naar een omgeving waarop eerst ingelogd moet worden voordat de vragen gesteld kunnen worden. Anders kun je wachten op spam-registraties.


Update 2024-11-12: er is nog geen generieke servicedesk applicatie beschikbaar, dus we ontkomen niet aan email adressen. Misschien moet er dan besloten worden dat alle vragen via het testteam gaan en dat zij ze intern routeren naar de juiste persoon.

...