MedMij:Vissue-MM-4014/FHIR Vaccination-Immunization - Bewerkingsoverzicht

Onno Gieling: /* Expected actions */

2022-12-09T15:47:55Z

Expected actions

← Oudere versie		Versie van 9 dec 2022 15:47
Regel 169:		Regel 169:

	====Expected actions====		====Expected actions====
	The PHR ~~SHALL process~~ the results~~. The PHR SHOULD contain all the resources that match the query and all the references resources that are included in the Bundle~~.		The PHR processes the results according to application-defined rules.

	=Release notes=		=Release notes=

Pieter Edelman: /* Expected actions */

2022-12-09T08:44:17Z

Expected actions

← Oudere versie		Versie van 9 dec 2022 08:44
Regel 169:		Regel 169:

	====Expected actions====		====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.		The PHR SHALL process the results. The PHR SHOULD contain all the resources that match the query and all the references resources that are included in the Bundle.

	=Release notes=		=Release notes=

Pieter Edelman: /* Expected actions */

2022-12-09T08:43:29Z

Expected actions

← Oudere versie		Versie van 9 dec 2022 08:43
Regel 113:		Regel 113:

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

	===XIS: response message===		===XIS: response message===

Pieter Edelman: /* Invocations */ Remove redundant information

2022-12-09T08:42:59Z

Invocations: Remove redundant information

← Oudere versie		Versie van 9 dec 2022 08:42
Regel 110:		Regel 110:
	\|}		\|}

	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 ~~and~~ the health professional/organization. ~~If those references are not in the Bundle, a~~ client SHALL be able to resolve ~~them at the source. The client may wish to have these references resolved~~ in the ~~Bundle by specifying the~~ [~~http~~:~~//hl7~~.~~org/fhir/R4/search.html~~#~~include {{fhir~~\|~~_include}}~~] parameter on the query. The server SHALL support this {{fhir\|_include}} parameter. It MAY include referenced resources even if the client doesn't ask for them if it doesn't support read operations for these resources.		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=====		=====Expected actions=====
Regel 122:		Regel 122:

	====Message semantics====		====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 ~~be a valid instance of these profiles. All resources SHALL include their related profile canonical URL~~ in the ~~{{fhir~~\|~~.meta.profile}} element in order to show compliance~~.		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}}		{{MedMij:V2020.01/NoteBoxPackage\|p1=nictiz.fhir.nl.r4.vaccinationimmunization\|p2=nictiz.fhir.nl.r4.zib2020\|v2=0.7.0-beta.1}}

Pieter Edelman: /* Invocations */

2022-12-09T08:26:01Z

Invocations

← Oudere versie		Versie van 9 dec 2022 08:26
Regel 110:		Regel 110:
	\|}		\|}

	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~~ and the ~~Health Professional~~/~~Organization~~. If those references are not in the Bundle, a client SHALL be able to resolve them at the source. The client may wish to have these references resolved in the Bundle by specifying the [http://hl7.org/fhir/R4/search.html#include {{fhir\|_include}}] parameter on the query. The server SHALL support this {{fhir\|_include}} parameter. It MAY include referenced resources even if the client doesn't ask for them if it doesn't support read operations for these resources.		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 and the health professional/organization. If those references are not in the Bundle, a client SHALL be able to resolve them at the source. The client may wish to have these references resolved in the Bundle by specifying the [http://hl7.org/fhir/R4/search.html#include {{fhir\|_include}}] parameter on the query. The server SHALL support this {{fhir\|_include}} parameter. It MAY include referenced resources even if the client doesn't ask for them if it doesn't support read operations for these resources.

	=====Expected actions=====		=====Expected actions=====

Mik de Jong: MM-4014: Added the includes in a table with description about the includes.

2022-12-08T14:07:16Z

MM-4014: Added the includes in a table with description about the includes.

@@ Regel 71: / Regel 71: @@
 ====Message semantics====
-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:
+'''Search'''
-<pre>GET [base]/Immunization{?_include=Immunization:patient&_include:iterate=Immunization:performer}</pre>
+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.
 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 and the Health Professional/Organization. If those references are not in the Bundle, a client SHALL be able to resolve them at the source. The client may wish to have these references resolved in the Bundle by specifying the [http://hl7.org/fhir/R4/search.html#include {{fhir|_include}}] parameter on the query. The server SHALL support this {{fhir|_include}} parameter. It MAY include referenced resources even if the client doesn't ask for them if it doesn't support read operations for these resources.

Niek van Galen: Clone of V6 production page for issue MM-4014

2022-12-08T08:55:32Z

Clone of V6 production page for issue MM-4014

Nieuwe pagina

{{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====
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{?_include=Immunization:patient&_include:iterate=Immunization: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 and the Health Professional/Organization. If those references are not in the Bundle, a client SHALL be able to resolve them at the source. The client may wish to have these references resolved in the Bundle by specifying the [http://hl7.org/fhir/R4/search.html#include {{fhir|_include}}] parameter on the query. The server SHALL support this {{fhir|_include}} parameter. It MAY include referenced resources even if the client doesn't ask for them if it doesn't support read operations for these resources.

=====Expected actions=====
The XIS SHALL process the query to retrieve patient's Immunization resources and the included 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 be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the {{fhir|.meta.profile}} element in order to show compliance.

{{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].