Brontekst bekijken van MedMij:Vissue-MM-4014/FHIR Vaccination-Immunization

{{IssuePaginaWaarschuwing|MM-4014|MedMij:V6/FHIR_Vaccination-Immunization}}
__NOINDEX__
__NUMBEREDHEADINGS__
{{DISPLAYTITLE:FHIR Implementation Guide: Vaccination-Immunization {{VersieInfo|Vaccinatie-Immunisatie}}}}
{{MedMij:Vprepub-6/Issuebox_FHIR_IG}}

[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
[[Bestand:Icoon_Nictiz_Cirkel_Informatiestandaard_Vaccinatie.svg|link=|87px|Vaccinatie-Immunisatie]] 

=Introduction=
This page describes patient's use case for the retrieval of vaccination results, in a personal health environment (PHR) context. Functional specifications are described at the [[MedMij:Vprepub-6/Ontwerp_Vaccinatie-Immunisatie| functional design wiki page]]. This use case consists of enabling a patient to view his own administered vaccinations in a PHR. The technical specification is described here. HL7 FHIR R4 is used for this purpose. Vaccinations are represented by the Immunization resources in FHIR. A transaction will retrieve all administered vaccinations from the XIS.

'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:IG:V1/FHIR_IG#Overarching principles|use case overarching principles]].

=Actors involved=
{| class="wikitable"
! colspan="2" style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | Actors
! colspan="2" style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | Systems
! colspan="2" style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | FHIR CapabilityStatements
|-
! style="text-align:left;" |Name
! style="text-align:left;" |Description
! style="text-align:left;" |Name
! style="text-align:left;" |Description
! style="text-align:left;" |Name
! style="text-align:left;" |Description
|-
| Patient
| The user of a personal healthcare environment.
| PHR
| Personal health record
| rowspan="2" | {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/imm-RetrieveServe|nictiz.fhir.nl.r4.vaccinationimmunization|pkgVersion=1.0.0-rc.1|title=CapabilityStatement: Retrieve Serve}}
| rowspan="2" | FHIR client/server requirements 
|-
| (Healthcare) provider
| The user of a XIS
| XIS
| (Healthcare) information system
|}

=Use case 1: Retrieve vaccinations =
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
{{FHIR-IG-Afsprakenstelsel-Note}}

==Introduction==
The retrieve vaccinations transaction is used by the PHR to retrieve vaccinations from a XIS.

==Actors==
{| class="wikitable" "cellpadding="10"
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;"| '''Transaction group'''
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;"| '''Transaction'''
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;"| '''Actor'''
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;"| '''Role'''
|-
|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve vaccinations(PULL)
|style="background-color: white;vertical-align:top;"|Retrieve vaccinations request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Request vaccinations from the XIS
|-
|style="background-color: white;vertical-align:top;"|Retrieve vaccinations response
|style="background-color: white;vertical-align:top;"|(Healthcare) provider (using a XIS)
|style="background-color: white;vertical-align:top;"|Serves vaccinations to the PHR
|}

==Invocations==
===PHR: request message===
The request message represents an HTTP GET parameterized query from the PHR to the XIS.

====Trigger events====
When the patient (PHR) wants to obtain vaccinations, it issues a retrieve vaccinations request message.

====Message semantics====
'''Search'''

The PHR executes an HTTP GET conform to the FHIR [http://hl7.org/fhir/http.html RESTful] and [http://hl7.org/fhir/search.html search] specification against the XIS's Observation endpoint. This search query URL is configurable by the PHR and has the following format.
 
<pre>
GET [base]/Immunization{?[includes]}
</pre>

'''Search Parameters'''

The PHR may supply, and the XIS shall be capable of processing, all inlcudes listed below. These includes are a selection of the defined includes. The includes can also be combined to retrieve multiple resources. 

{| class="wikitable" 
! colspan="3" style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | Immunization
|-
| style="font-weight: bold;" | Name
| style="font-weight: bold;" | Description
| style="font-weight: bold;" | Example
|-
| <code>patient</code>
| This will specify the resource for the patient that the immunization is performed on.

|
Retrieve the Immunization and Patient resource:
<pre>GET [base]/Immunization?_include:patient</pre>
|-
| <code>location</code>
| This will specify the resource for the location where the Immunization took place.
|
Retrieve the Immunization and Location resource:
<pre>GET [base]/Immunization?_include:location</pre>
|-
| <code>performer</code>
| This will specify the resource for the healthcareprovider who performed the immunization on the patient.
|
Retrieve the Immunization and Practitioner or Organization resource:
<pre>GET [base]/Immunization?_include:performer</pre>
|}

At this point in time, there are no use cases for filter parameters on the query. The stated query will return a Bundle with all known administered immunizations. Each immunization is conveyed in an Immunization resource. The Immunization resource will contain references to actors such as the patient (Patient resource), the health professional (PractitionerRole and Practitioner resources) and the organization (Organization resource). The client SHALL be able to resolve there referenced resources, as described in the [[FHIR:V1.0_FHIR_IG_R4#Search_results|FHIR R4 Implementation Guide]].

=====Expected actions=====
The XIS SHALL process the query to retrieve patient's Immunization resources and the referenced resources.

===XIS: response message===
The XIS returns an HTTP Status code appropriate to the processing as well as a FHIR Bundle including the matching information.

====Trigger events====
The XIS completed processing of the retrieve vaccinations request message.

====Message semantics====
The returned data to the PHR should conform to the profiles listed in the table below. The resources in the response message SHALL conform to the requirements as described in the [[FHIR:V1.0_FHIR_IG_R4#Profile_use_and_declaration|FHIR R4 Implementation Guide]]. 

{{MedMij:V2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.r4.vaccinationimmunization|p2=nictiz.fhir.nl.r4.zib2020|v2=0.7.0-beta.1}}


{| class="wikitable"
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | Profile name
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | FHIR Resource
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | HCIM EN
! style="text-align:left; background-color: #4AB8A7; color: white; font-weight: bold;" | Canonical URL
|-
| nl core Vaccination event 
| Immunization
| [https://zibs.nl/wiki/Vaccinatie-v4.0(2020NL) Vaccination]
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-Vaccination-event|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core Patient
| Patient
| [https://zibs.nl/wiki/Patient-v3.2(2020EN) Patient]
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core HealthProfessional
| Practitioner
| rowspan="2" | [https://zibs.nl/wiki/HealthProfessional-v3.5(2020EN) HealthProfessional]
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core HealthProfessional PractitionerRole
| PractionerRole
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core HealthcareProvider Organization
| Organization 
| rowspan="2" | [https://zibs.nl/wiki/HealthcareProvider-v3.4(2020EN) HealthcareProvider]
|{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core HealthcareProvider
| Location
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
| nl core PharmaceuticalProduct 
| Medication
| [https://zibs.nl/wiki/PharmaceuticalProduct-v2.1.2(2020EN) PharmaceuticalProduct]
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-PharmaceuticalProduct|nictiz.fhir.nl.r4.zib2020|pkgVersion=0.7.0-beta.1}}
|-
|}

====Expected actions====
The PHR SHALL process the results. The PHR SHOULD contain all the resources that match the query and all the reference resources that are included in the Bundle.

=Release notes=
Release notes can be found on the [[MedMij:Vprepub-6/Ontwerp_Vaccinatie-Immunisatie#Release_notes| functional design page]].

=Support=
For questions and change requests regarding this IG, please create a ticket in [https://bits.nictiz.nl/projects/MM BITS].