MedMij:V2020.01/FHIR eAfspraak: verschil tussen versies

Uit informatiestandaarden
Naar navigatie springen Naar zoeken springen
(→‎Use case: cancel/reschedule an appointment: Added notebox with url to the 2019.01 publication)
k (Beveiligde "MedMij:V2020.01/FHIR eAfspraak": Protect production page from accidental edits ([Bewerken=Alleen beheerders toestaan] (vervalt niet) [Hernoemen=Alleen beheerders toestaan] (vervalt niet)))
 
(16 tussenliggende versies door 5 gebruikers niet weergegeven)
Regel 1: Regel 1:
 
__NUMBEREDHEADINGS__
 
__NUMBEREDHEADINGS__
 
{{DISPLAYTITLE:MedMij FHIR Implementation Guide - eAfspraak {{VersieInfo|eAfspraak}}}}
 
{{DISPLAYTITLE:MedMij FHIR Implementation Guide - eAfspraak {{VersieInfo|eAfspraak}}}}
−
{{MedMij:Vprepub/Issuebox_FHIR_IG}}
+
{{MedMij:V2020.01/Issuebox_FHIR_IG}}
  
 
[[Bestand:EAfspraak_icoon_zonder_tekst.png |link=|links |87px|eAfspraak]]  
 
[[Bestand:EAfspraak_icoon_zonder_tekst.png |link=|links |87px|eAfspraak]]  
Regel 7: Regel 7:
 
<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch   
 
<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch   
 
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]                 
 
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]                 
−
circle 1013 224 212 [[MedMij:Vprepub/OntwerpeAfspraken|Functioneel]]                 
+
circle 1013 224 212 [[MedMij:V2020.01/OntwerpeAfspraken|Functioneel]]                 
−
circle 1787 230 212 [[MedMij:Vprepub/FHIR_IG|Technisch]]                 
+
circle 1787 230 212 [[MedMij:V2020.01/FHIR_IG|Technisch]]                 
 
desc none                     
 
desc none                     
 
</imagemap>
 
</imagemap>
Regel 16: Regel 16:
 
=Introduction=
 
=Introduction=
 
This page describes how a patient can manage his health care related appointments in a MedMij context using the HL7 FHIR Standard. Initially, this guide will contain information on how to request existing appointment information. Guidance on how to create, update, or cancel appointments will be available here as well at a later stage.  
 
This page describes how a patient can manage his health care related appointments in a MedMij context using the HL7 FHIR Standard. Initially, this guide will contain information on how to request existing appointment information. Guidance on how to create, update, or cancel appointments will be available here as well at a later stage.  
−
The functional requirements for this use case can be found in the [[MedMij:Vprepub/Ontwerpen|functional design]].
+
The functional requirements for this use case can be found in the [[MedMij:V2020.01/Ontwerpen|functional design]].
  
−
'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:Vprepub/FHIR_IG#Use case overarching principles|use case overarching principles]].
+
'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:V2020.01/FHIR_IG#Use case overarching principles|use case overarching principles]].
  
 
=Use case: retrieve appointments=
 
=Use case: retrieve appointments=
Regel 27: Regel 27:
 
The goal of this use case is to give patients an overview of their appointments with all healthcare providers. The appointment information that is shared with the patient will contain start and end date/time, location, type of appointment, patient instructions, health care professionals present. Below is described how a PHR can retrieve this information and how a XIS should make this information available.
 
The goal of this use case is to give patients an overview of their appointments with all healthcare providers. The appointment information that is shared with the patient will contain start and end date/time, location, type of appointment, patient instructions, health care professionals present. Below is described how a PHR can retrieve this information and how a XIS should make this information available.
  
−
==Actors==
+
==Actors involved==
−
{| class="wikitable" "cellpadding="10"
+
{| class="wikitable"
−
! style="text-align:left;"| '''Actor'''
+
! colspan="3" style="text-align:left;" | Actors
−
! style="text-align:left;"| '''Role'''
+
! colspan="2" style="text-align:left;" | Systems
 +
! colspan="2" style="text-align:left;" | FHIR Capability Statements
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
+
! style="text-align:left;" |Name
−
|style="background-color: white;vertical-align:top;"|Request appointments from the XIS
+
! style="text-align:left;" |Description
 +
! style="text-align:left;" |Role
 +
! style="text-align:left;" |Name
 +
! style="text-align:left;" |Description
 +
! style="text-align:left;" |Name
 +
! style="text-align:left;" |Description
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
+
| Patient
−
|style="background-color: white;vertical-align:top;"|Serves appointments to the PHR
+
| The user of a personal healthcare environment.
 +
| Request appointments from the XIS
 +
| PHR
 +
| Personal health record
 +
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eappointment-clientcapabilities|nictiz.fhir.nl.stu3.eafspraak|pkgVersion=1.0.5|title=CapabilityStatement: Client}}
 +
| FHIR Client requirements
 +
|-
 +
| Healthcare professional
 +
| The user of a XIS
 +
|Serves appointments to the PHR
 +
| XIS
 +
| Healthcare information system
 +
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eappointment-servercapabilities|nictiz.fhir.nl.stu3.eafspraak|pkgVersion=1.0.5|title=CapabilityStatement: Server}}
 +
| FHIR Server requirements
 
|}
 
|}
  
Regel 67: Regel 86:
  
 
===Server - XIS===
 
===Server - XIS===
−
The returned data to the PHR should conform to the HCIMS and their associate profiles listed in the table below.
+
The returned data to the PHR should conform to the HCIMs and their associate profiles listed in the table below.
  
−
{{MedMij:NoteBoxPackage|p1=nictiz.fhir.nl.stu3.eafspraak|p2=nictiz.fhir.nl.stu3.zib2017}}
+
{{MedMij:V2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.eafspraak|v1Min=1.0.0|p2=nictiz.fhir.nl.stu3.zib2017|v2Min=2.0.0}}
  
 
{| class="wikitable" width="1400px"
 
{| class="wikitable" width="1400px"
Regel 81: Regel 100:
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
−
| Zorgverlener
+
| rowspan="2" | Zorgverlener
−
| HealthProfessional
+
| rowspan="2" | HealthProfessional
 
| Practitioner
 
| Practitioner
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
−
| Zorgaanbieder
+
| PractitionerRole
−
| HealthcareProvider
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole|nictiz.fhir.nl.stu3.zib2017}}
 +
|-
 +
| rowspan="2" | Zorgaanbieder
 +
| rowspan="2" | HealthcareProvider
 
| Organization
 
| Organization
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017}}
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017}}
 +
|-
 +
| Location
 +
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-location|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Afspraak
 
| Afspraak
Regel 96: Regel 121:
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment|nictiz.fhir.nl.stu3.eafspraak}}
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment|nictiz.fhir.nl.stu3.eafspraak}}
 
|-
 
|-
 +
<span id="LocationNotSuporrted"></span>{{NoteBox|If a Location is not registered as separate data in relation to Organization data at the source system (especially at General Practitioner Systems (Huisartsen Informatie Systeem)), a Location resource with minimal data should be constructed as a forwarder to the Organization resource where the Appointment will take place ([[MedMij:V2020.01/FHIR_eAfspraak-LocationExample|example]]).}}
 
|}
 
|}
−
{{Sjabloon:Voorbeelden}}
 
−
 
−
=Use case: book an appointment=
 
−
{{NoteBox|1= The current version of the use case 'book an appointment' can be found in the [[MedMij:V2019.01_FHIR_eAfspraak|2019.01 publication]]. }}
 
−
 
−
=Use case: cancel/reschedule an appointment=
 
−
{{NoteBox|1= The current version of the use case 'cancel/reschedule an appointment' can be found in the [[MedMij:V2019.01_FHIR_eAfspraak|2019.01 publication]]. }}
 
−
 
−
=Terminology, NamingSystems, Mappings=
 
−
 
−
===Terminology===
 
−
Relevant ValueSets can be found through the ValueSet bindings in the listed StructureDefinitions. All ValueSets can be found here [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ValueSet here] and can be downloaded as a .zip in XML or JSON format.
 
−
 
−
===NamingSystems===
 
−
Relevant NamingSystems can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=NamingSystem here].
 
−
 
−
===Mappings===
 
−
A FHIR ConceptMap resource is provided when a FHIR value set is used instead of a HCIM value set. A ConceptMap maps the values between the two value sets. These ConceptMaps can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ConceptMap here].
 
−
 
−
An explanation about mappings can be found at [[MedMij:Vprepub/FHIR_IG#Mapping_of_coded_concepts|Mapping of coded concepts]].
 
  
 
=Release notes=
 
=Release notes=
−
Release notes can be found on the [[MedMij:Vprepub/OntwerpeAfspraak#Release_notes| functional design page]].
+
Release notes can be found on the [[MedMij:V2020.01/OntwerpeAfspraak#Release_notes| functional design page]].

Huidige versie van 22 nov 2022 om 13:35



eAfspraak
Naar medmij.nl
AfsprakenstelselFunctioneelTechnischAfspraken-Functioneel-Technisch

1 Introduction

This page describes how a patient can manage his health care related appointments in a MedMij context using the HL7 FHIR Standard. Initially, this guide will contain information on how to request existing appointment information. Guidance on how to create, update, or cancel appointments will be available here as well at a later stage. The functional requirements for this use case can be found in the functional design.

Note: This implementation guide builds on the general guidelines described in the use case overarching principles.

2 Use case: retrieve appointments

Go to Afsprakenstelsel

This FHIR implementation guide assumes that the PHR system is able to make a connection to the right XIS that contains the patient's information. It does not provide information on finding the right XIS nor does it provide information about security. Moreover, each transaction is performed in the context of a specific authenticated patient, for whose context (token) has been established using the authentication mechanisms described in the 'Afsprakenstelsel'. Each XIS Gateway is required to perform filtering based on the patient associated with the context for the request, so only the records associated with the authenticated patient are returned. For this reason, search parameters should not be included for patient identification.

2.1 Introduction

The goal of this use case is to give patients an overview of their appointments with all healthcare providers. The appointment information that is shared with the patient will contain start and end date/time, location, type of appointment, patient instructions, health care professionals present. Below is described how a PHR can retrieve this information and how a XIS should make this information available.

2.2 Actors involved

Actors Systems FHIR Capability Statements
Name Description Role Name Description Name Description
Patient The user of a personal healthcare environment. Request appointments from the XIS PHR Personal health record Verwijzing.png CapabilityStatement: Client FHIR Client requirements
Healthcare professional The user of a XIS Serves appointments to the PHR XIS Healthcare information system Verwijzing.png CapabilityStatement: Server FHIR Server requirements

2.3 Invocations

2.3.1 Client - PHR

2.3.1.1 Search for appointments

The PHR executes an HTTP GET conform to the FHIR RESTful and search specification against the XIS's Appointment endpoint. This search query URL is configurable by the PHR and has the following format: 

GET [base]/Appointment?date=[date]

The PHR may use, and the XIS shall be capable of processing, the following parameters to configure the search query:

Observation
Name Type Description Example
date date Appointment date/time based on start date/time. Retrieve appointments with a start date/time from 01-01-2018 onwards: 
GET [base]/Appointment?date=gt2017-12-31

Retrieve appointments with start date/time from 01-01-2018 until 01-03-2018: 

GET [base]/Appointment?date=ge2018-01-01&date=lt2018-03-01

2.3.2 Server - XIS

The returned data to the PHR should conform to the HCIMs and their associate profiles listed in the table below.

Em.png

MedMij uses the FHIR Packaging mechanism. This conveniently bundles all profiles, terminology, example material and other conformance resources you need into a single archive, which can be downloaded or installed using the appropriate FHIR tooling. This version of the information standard uses the following packages:

Note: packages use Semantic Versioning. Other versions can be used at will as long as they have the same major.minor number or a minor number higher than the stated version.

Name NL Name EN FHIR Resource URL profile
Patient Patient Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Zorgverlener HealthProfessional Practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
PractitionerRole http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Zorgaanbieder HealthcareProvider Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Location http://fhir.nl/fhir/StructureDefinition/nl-core-location
Afspraak Appointment Appointment http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment

Em.png

If a Location is not registered as separate data in relation to Organization data at the source system (especially at General Practitioner Systems (Huisartsen Informatie Systeem)), a Location resource with minimal data should be constructed as a forwarder to the Organization resource where the Appointment will take place (example).

3 Release notes

Release notes can be found on the functional design page.

Overgenomen van "https://informatiestandaarden.test-nictiz.nl/index.php?title=MedMij:V2020.01/FHIR_eAfspraak&oldid=144623"