Huidige versie van 6 dec 2023 om 13:59

Work in progress - See official publication here.

Introduction

This page describes a patient's use case, in a personal health record (PHR) context, for exchanging allergy and intolerance data. Functional specification of this use case is described in the functional design wiki pages.

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

Actors involved

Persons		Systems		FHIR Capability Statements
Name	Description	Name	Description	Name	Description
Patient	The user of a personal healthcare environment.	PHR	Personal health record	CapabilityStatement: Client	AllergyIntolerance client requirements
Healthcare professional	The user of a XIS	XIS	Healthcare information system	CapabilityStatement: Server	AllergyIntolerance server requirements

Use case: Retrieve AllergyIntolerance information

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.

Introduction

The retrieve AllergyIntolerance transaction is used by the PHR to retrieve allergy and intolerance information from the XIS.

Actors

Transaction group	Transaction	Actor	Role
Retrieve AllergyIntolerance(PULL)	Retrieve AllergyIntolerance request	Patient (using a PHR)	Request allergy and intolerance information from the XIS
Retrieve AllergyIntolerance(PULL)	Retrieve AllergyIntolerance response	Healthcare professional (using a XIS)	Serves allergy and intolerance information to the PHR

Invocations

PHR: request message

The request message represents an HTTP GET query from the PHR to the XIS.

Trigger Events

When the patient(PHR) wants to obtain allergy and intolerance information, it issues a retrieve AllergyIntolerance request message.

Message Semantics

The PHR executes an HTTP GET conform to the FHIR RESTful and search specification against the XIS's AllergyIntolerance endpoint. This search query has the following format.

GET [base]/AllergyIntolerance

Expected Actions

The XIS shall process the query to discover AllergyIntolerance resources that match the patient in the context.

XIS: response message

The XIS returns an HTTP Status code appropriate to the processing as well as a FHIR Bundle including the allergy and intolerance information.

Trigger Events

The XIS completed processing of the Retrieve AllergyIntolerance request message.

Message Semantics

The returned data to the PHR should conform to the HCIMs and associated 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 meta.profile element in order to show compliance.

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:

nictiz.fhir.nl.stu3.zib2017 version 2.0.0 or compatible (latest is )

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.

Zib name NL	Zib name EN	FHIR Resource	URL profile
Patient	Patient	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
AllergieIntolerantie	AllergyIntolerance	AllergyIntolerance	http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance
Zorgverlener	HealthProfessional	Practitioner	http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
Zorgverlener	HealthProfessional	PractitionerRole	http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Zorgaanbieder	HealthcareProvider	Organization	http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Contactpersoon	ContactPerson	Patient.contact	http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson

Expected Actions

The PHR processes the results according to application-defined rules. The PHR should be robust as the response may contain AllergyIntolerance information resources as mentioned in the former section.

Use case: Retrieve AllergyIntolerance612ToFHIRConversion

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.

Introduction

A PHR uses the retrieve AllergyIntolerance612ToFHIRConversion transaction to retrieve "6.12-based" allergy and intolerance information from a XIS. This information is based on a conversion from the 6.12 information standard. The XIS converts the requested information by a PHR to FHIR-resources.

The 6.12 AllergyIntolerance information is originally exchanged in HL7v3-messaging format. For interested readers the HL7v3-specifications can be found in the 6.12 template for 'potential contraindications'.

However, please note that it is not necessary for a PHR to have knowledge of the HL7v3-format to implement this use case.

Actors

Transaction group	Transaction	Actor	Role
Retrieve AllergyIntolerance612ToFHIRConversion (PULL)	Retrieve AllergyIntolerance612ToFHIRConversion request	Patient (using a PHR)	Request allergy and intolerance information from the XIS
Retrieve AllergyIntolerance612ToFHIRConversion (PULL)	Retrieve AllergyIntolerance612ToFHIRConversion response	Healthcare professional (using a XIS)	Serves allergy and intolerance information to the PHR

Invocations

PHR: request message

The request message represents an HTTP GET query from the PHR to the XIS.

Trigger Events

When the patient(PHR) wants to obtain allergy and intolerance information, it issues a retrieve AllergyIntolerance612ToFHIRConversion request message.

Message Semantics

The PHR executes an HTTP GET conform to the FHIR RESTfull and search specification against the XIS's AllergyIntolerance612ToFHIRConversion endpoint. This search query has the following format.

GET [base]/AllergyIntolerance

Expected Actions

The XIS shall process the query to discover AllergyIntolerance resources that are part of the 6.12 information standard and match the patient in the context.

XIS: response message

The XIS returns an HTTP Status code appropriate to the processing as well as a FHIR Bundle including the appropriate allergy and intolerance information.

Trigger Events

The XIS completed processing of the Retrieve AllergyIntolerance request message.

Message Semantics

The returned data to the PHR should conform to the HCIMs and their associated 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 meta.profile element in order to show compliance.

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:

nictiz.fhir.nl.stu3.zib2017 version or compatible

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.

Zib name NL	Zib name EN	FHIR Resource	URL profile
Patient	Patient	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
AllergieIntolerantie	AllergyIntolerance	AllergyIntolerance	http://nictiz.nl/fhir/StructureDefinition/mp612-AllergyIntoleranceToFHIRConversion
Zorgverlener	HealthProfessional	Practitioner	http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
Zorgverlener	HealthProfessional	PractitionerRole	http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Zorgaanbieder	HealthcareProvider	Organization	http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Contactpersoon	ContactPerson	Patient.contact	http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson

Expected Actions

The PHR processes the results according to application-defined rules. The PHR should be robust as the response may contain AllergyIntolerance information resources as mentioned in the former section.

Release notes

Release notes can be found on the functional design page.

Support

For questions and change requests regarding the information on this page, please create a ticket in Servicedesk Portal.

@@ Regel 1: / Regel 1: @@
 __NOINDEX__
 {{DISPLAYTITLE:MedMij FHIR Implementation Guide AllergyIntolerance {{VersieInfo|AllergieIntolerantie}}}}
-{{MedMij:Vprepub/Issuebox_FHIR_IG}}
+{{MedMij:Vprepub-2020.01/Issuebox_FHIR_IG}}
 [[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
@@ Regel 7: / Regel 7: @@
 <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 1013 224 212 [[MedMij:Vprepub/OntwerpAllergieIntolerantie|Functioneel]]
+circle 1013 224 212 [[MedMij:Vprepub-2020.01/OntwerpAllergieIntolerantie|Functioneel]]
-circle 1787 230 212 [[MedMij:Vprepub/FHIR_IG|Technisch]]
+circle 1787 230 212 [[MedMij:Vprepub-2020.01/FHIR_IG|Technisch]]
 desc none
 </imagemap>
@@ Regel 16: / Regel 16: @@
 =Introduction=
-[[Bestand:Functioneel-02.png|link=MedMij:Vprepub/Ontwerpen |100px|rechts|Functional design|Go to functional design]]
+[[Bestand:Functioneel-02.png|link=MedMij:Vprepub-2020.01/Ontwerpen |100px|rechts|Functional design|Go to functional design]]
-This page describes a patient's use case, in a personal health record (PHR) context, for exchanging allergy and intolerance data. Functional specification of this use case is described in the [[MedMij:Vprepub/Ontwerpen| functional design wiki pages]]. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.
+This page describes a patient's use case, in a personal health record (PHR) context, for exchanging allergy and intolerance data. Functional specification of this use case is described in the [[MedMij:Vprepub-2020.01/Ontwerpen| functional design wiki pages]].
+'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:Vprepub-2020.01/FHIR_IG#Use case overarching principles|use case overarching principles]].
 =Actors involved=
@@ Regel 34: / Regel 36: @@
 |-
 | Patient
-| The user of a personal healthcare enviorment.
+| The user of a personal healthcare environment.
 | PHR
 | Personal health record
@@ Regel 49: / Regel 51: @@
 =Use case: Retrieve AllergyIntolerance information=
+[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |128px|Go to Afsprakenstelsel]]
 {{FHIR-IG-Afsprakenstelsel-Note}}
@@ Regel 61: / Regel 64: @@
 ! style="text-align:left;"| '''Role'''
 |-
-|style="background-color: white;vertical-align:top;" rowspan="3"|Retrieve AllergyIntolerance(PULL)
+|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve AllergyIntolerance(PULL)
 |style="background-color: white;vertical-align:top;"|Retrieve AllergyIntolerance request
 |style="background-color: white;vertical-align:top;"|Patient (using a PHR)
@@ Regel 79: / Regel 82: @@
 ====Message Semantics====
-The PHR executes an HTTP GET conform to the FHIR [http://hl7.org/fhir/http.html RESTfull] and [http://hl7.org/fhir/search.html search] specification against the XIS's AllergyIntolerance endpoint. This search query has the following format.
+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 AllergyIntolerance endpoint. This search query has the following format.
 <pre>
 GET [base]/AllergyIntolerance
 </pre>
-=====Search Parameters=====
-No query parameters are defined for this use case. The PHR searches on all AllergyIntolerance resources available for the patient using a HTTP GET on the AllergyIntolerance endpoint without parameters.
 =====Expected Actions=====
@@ Regel 98: / Regel 98: @@
 ====Message Semantics====
-Based on the query results, the XIS will either return an error or success. When the XIS needs to report an error, it SHALL use HTTP error response codes and SHOULD include a FHIR OperationOutcome resource with more details on the failure. If the request message is processed successfully, whether or not any AllergyIntolerance resources are found, the HTTP status code SHALL be 200.
+The returned data to the PHR should conform to the HCIMs and associated 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 ''meta.profile'' element in order to show compliance.
-The response message shall be a Bundle resource of type "searchset" containing zero or more FHIR resources as entries. If the XIS is sending warnings, the Bundle resource SHALL also contain a FHIR OperationOutcome resource that contains those warnings. The FHIR specification describes the relevant sections:
+{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1Min=2.0.0}}
-*[http://hl7.org/fhir/STU3/http.html RESTful API framework]
-*[http://hl7.org/fhir/STU3/search.html#errors Search errors]
-*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
-*[http://hl7.org/fhir/operationoutcome.html OperationOutcome resource]
-=====Message resource content=====
-The returned data to the PHR should conform to the zib AllergyIntolerance profile. The table below shows the relevant zibs and their profiles.
-{{MedMij:NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1=2.0.x}}
 {| class="wikitable"
@@ Regel 144: / Regel 135: @@
 | {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson|nictiz.fhir.nl.stu3.zib2017}}
 |}
-{{Sjabloon:Voorbeelden}}
 ====Expected Actions====
 The PHR processes the results according to application-defined rules. The PHR should be robust as the response may contain AllergyIntolerance information resources as mentioned in the former section.
-==Interactions, operations, search parameters==
+=Use case: Retrieve AllergyIntolerance612ToFHIRConversion=
-===Interactions===
+[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |128px|Go to Afsprakenstelsel]]
-The following logical interactions are needed for the retrieve AllergyIntolerance information transaction:
-* [http://hl7.org/fhir/STU3/http.html#search Search]
-===Operations===
-No operations are defined or needed for this transaction.
-===Search parameters===
-No search parameters are defined or needed for this transaction.
-=Use case: Retrieve AllergyIntolerance612ToFHIRConversion =
 {{FHIR-IG-Afsprakenstelsel-Note}}
@@ Regel 177: / Regel 157: @@
 ! style="text-align:left;"| '''Role'''
 |-
-|style="background-color: white;vertical-align:top;" rowspan="3"|Retrieve AllergyIntolerance612ToFHIRConversion (PULL)
+|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve AllergyIntolerance612ToFHIRConversion (PULL)
 |style="background-color: white;vertical-align:top;"|Retrieve AllergyIntolerance612ToFHIRConversion request
 |style="background-color: white;vertical-align:top;"|Patient (using a PHR)
@@ Regel 200: / Regel 180: @@
 GET [base]/AllergyIntolerance
 </pre>
-=====Search Parameters=====
-No query parameters are defined for this use case. The PHR searches on all AllergyIntolerance resources available for the patient using a HTTP GET on the AllergyIntolerance endpoint without parameters.
 =====Expected Actions=====
@@ Regel 214: / Regel 191: @@
 ====Message Semantics====
-Based on the query results, the XIS will either return an error or success. When the XIS needs to report an error, it SHALL use HTTP error response codes and SHOULD include a FHIR OperationOutcome resource with more details on the failure. If the request message is processed successfully, whether or not any AllergyIntolerance resources are found, the HTTP status code SHALL be 200.
+The returned data to the PHR should conform to the HCIMs and their associated 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 ''meta.profile'' element in order to show compliance.
-The response message shall be a Bundle resource of type "searchset" containing zero or more FHIR resources as entries. If the XIS is sending warnings, the Bundle resource SHALL also contain a FHIR OperationOutcome resource that contains those warnings. The FHIR specification describes the relevant sections:
+{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017}}
-*[http://hl7.org/fhir/STU3/http.html RESTful API framework]
-*[http://hl7.org/fhir/STU3/search.html#errors Search errors]
-*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
-*[http://hl7.org/fhir/operationoutcome.html OperationOutcome resource]
-=====Message resource content=====
-The returned data to the PHR should conform to the zib AllergyIntolerance profile. The table below shows the relevant zibs and their profiles.
-{{MedMij:NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1=2.0.x}}
 {| class="wikitable"
@@ Regel 260: / Regel 228: @@
 | {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson|nictiz.fhir.nl.stu3.zib2017}}
 |}
-{{Sjabloon:Voorbeelden}}
 ====Expected Actions====
 The PHR processes the results according to application-defined rules. The PHR should be robust as the response may contain AllergyIntolerance information resources as mentioned in the former section.
-==Interactions, operations, search parameters==
+=Release notes=
-===Interactions===
+Release notes can be found on the [[MedMij:Vprepub-2020.01/OntwerpAllergieIntolerantie#Release_notes|functional design page]].
-The following logical interactions are needed for the retrieve AllergyIntolerance612ToFHIRConversion transaction:
-* [http://hl7.org/fhir/STU3/http.html#search Search]
-===Operations===
+{{MedMij:Sjabloon_Support}}
-No operations are defined or needed for this transaction.
-===Search parameters===
-No search parameters are defined or needed for this transaction.
-=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 can be found on the [[MedMij:Vprepub/OntwerpAllergieIntolerantie#Release_notes|functional design page]].

MedMij:Vprepub-2020.01/FHIR AllergyIntolerance: verschil tussen versies

Huidige versie van 6 dec 2023 om 13:59

Inhoud

Introduction

Actors involved

Use case: Retrieve AllergyIntolerance information

Introduction

Actors

Invocations

PHR: request message

Trigger Events

Message Semantics

Expected Actions

XIS: response message

Trigger Events

Message Semantics

Expected Actions

Use case: Retrieve AllergyIntolerance612ToFHIRConversion

Introduction

Actors

Invocations

PHR: request message

Trigger Events

Message Semantics

Expected Actions

XIS: response message

Trigger Events

Message Semantics

Expected Actions

Release notes

Support

Navigatiemenu

Zoeken