MedMij:Vprepub-2019.01 FHIR AllergyIntolerance: verschil tussen versies
k (Tekst vervangen - "pkgVersion=1.3.10" door "pkgVersion=1.3.12") |
(Replace the deprecation issuebox) |
||
| (Een tussenliggende versie door dezelfde gebruiker niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
| + | {{MedMij:Vprepub-2019.01_AllergieIntolerantie2_Uitgefaseerd}} | ||
__NOINDEX__ | __NOINDEX__ | ||
{{DISPLAYTITLE:MedMij FHIR Implementation Guide AllergyIntolerance {{VersieInfo|AllergieIntolerantie|release=V2019.01}}}} | {{DISPLAYTITLE:MedMij FHIR Implementation Guide AllergyIntolerance {{VersieInfo|AllergieIntolerantie|release=V2019.01}}}} | ||
| Regel 281: | Regel 282: | ||
=Release notes= | =Release notes= | ||
Release notes can be found on the [[MedMij:Vprepub-2019.01_OntwerpAllergieIntolerantie#Release_notes|functional design page]]. | Release notes can be found on the [[MedMij:Vprepub-2019.01_OntwerpAllergieIntolerantie#Release_notes|functional design page]]. | ||
| + | {{EindUitgefaseerd}} | ||
Huidige versie van 13 sep 2022 om 13:14
|
|
Deze versie van de informatiestandaard is per 1-7-2022 uitgefaseerd. Zie de MedMij-overzichtspagina voor de actuele versies van de MedMij-informatiestandaarden. This version of this information standard has been deprecated as of 1-7-2022. Consult the MedMij overview page for the current versions of MedMij information standards. |
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. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.
Actors involved
| Persons | Systems | FHIR Capability Statements | |||
|---|---|---|---|---|---|
| Name | Description | Name | Description | Name | Description |
| Patient | The user of a personal healthcare enviorment. | 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 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 RESTfull and search specification against the XIS's AllergyIntolerance endpoint. This search query has the following format.
GET [base]/AllergyIntolerance
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
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
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 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:
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. 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 examples, profiles and other conformance resources you need into a single download. For more background information see the the FHIR implementation guide. This version of the information standard depends on Nictiz package 1.3.x. Please note that the direct links to the various conformance resources below will take you to the latest version, which might not match the package version. At time of writing, there is no way to render the conformance resource as found in the package. This is on the roadmap for Simplifier. |
| 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 |
| 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 |
Example instances of FHIR resources can be found on Simplifier. Please note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of any information standard.
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
Interactions
The following logical interactions are needed for the retrieve AllergyIntolerance information transaction:
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
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 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
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
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
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 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:
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. 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 examples, profiles and other conformance resources you need into a single download. For more background information see the the FHIR implementation guide. This version of the information standard depends on Nictiz package 1.3.x. Please note that the direct links to the various conformance resources below will take you to the latest version, which might not match the package version. At time of writing, there is no way to render the conformance resource as found in the package. This is on the roadmap for Simplifier. |
| 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 |
| 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 |
Example instances of FHIR resources can be found on Simplifier. Please note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of any information standard.
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
Interactions
The following logical interactions are needed for the retrieve AllergyIntolerance612ToFHIRConversion transaction:
Operations
No operations are defined or needed for this transaction.
Search parameters
No search parameters are defined or needed for this transaction.
Terminology, NamingSystems, Mappings
Relevant ValueSets, NamingSystems and ConceptMaps can be found in the packages referenced in the Retrieve AllergyIntolerance response message content and Retrieve AllergyIntolerance612ToFHIRConversion response message content sections.
The HCIM ValueSets used in the profiles are included in the package (or one of its dependencies). When a FHIR core ValueSet must be used instead of an HCIM ValueSet, a FHIR ConceptMap resource is provided to map the values between the two sets. An explanation about mappings can be found at in the overarching principles.
Release notes
Release notes can be found on the functional design page.