|
|
| (Een tussenliggende versie door een andere gebruiker niet weergegeven) |
| Regel 1: |
Regel 1: |
| − | {{DISPLAYTITLE:MedMij FHIR Implementation Guide AllergyIntolerance 1.0.0}} | + | {{DISPLAYTITLE:MedMij FHIR Implementation Guide AllergyIntolerance 1.0.0 - Archived}} |
| | {{MedMij:V2018.06_Issuebox_FHIR_IG}} | | {{MedMij:V2018.06_Issuebox_FHIR_IG}} |
| | | | |
| − | [[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
| + | {{Gearchiveerd|20-03-2023|Allergieintolerantie 2018.06.zip}} |
| − | [[Bestand:Allergie.png|link=|87px |links||AllergyIntolerance]]
| |
| − | <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:V2018.06_OntwerpAllergieIntolerantie|Functioneel]]
| |
| − | circle 1787 230 212 [[MedMij:V2018.06_FHIR_IG|Technisch]]
| |
| − | desc none
| |
| − | </imagemap>
| |
| − | | |
| − | __TOC__
| |
| − | | |
| − | | |
| − | =Introduction=
| |
| − | [[Bestand:Functioneel-02.png|link=MedMij:V2018.06_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:V2018.06_Ontwerpen| functional design wiki pages]]. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.
| |
| − | | |
| − | =Actors involved=
| |
| − | {| class="wikitable"
| |
| − | ! colspan="2" style="text-align:left;" | Persons
| |
| − | ! colspan="2" style="text-align:left;" | Systems
| |
| − | ! colspan="2" style="text-align:left;" | FHIR Capability Statements
| |
| − | |-
| |
| − | ! 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 enviorment.
| |
| − | | PHR
| |
| − | | Personal health record
| |
| − | |[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/allergyintolerance-clientcapabilities|title=CapabilityStatement: Client|scope=nictiz.fhir.nl.stu3.zib2015@1.0.0}}
| |
| − | | AllergyIntolerance client requirements
| |
| − | |-
| |
| − | | Healthcare professional
| |
| − | | The user of a XIS
| |
| − | | XIS
| |
| − | | Healthcare information system
| |
| − | |[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/allergyintolerance-servercapabilities|title=CapabilityStatement: Server|scope=nictiz.fhir.nl.stu3.zib2015@1.0.0}}
| |
| − | | AllergyIntolerance server requirements
| |
| − | |}
| |
| − | | |
| − | =Use case: Retrieve AllergyIntolerance information=
| |
| − | {{FHIR-IG-Afsprakenstelsel-Note}}
| |
| − | | |
| − | ==Introduction==
| |
| − | The retrieve AllergyIntolerance transaction is used by the PHR to retrieve allergy and intolerance information from the XIS.
| |
| − | | |
| − | ==Actors==
| |
| − | {| class="wikitable" "cellpadding="10"
| |
| − | ! style="text-align:left;"| '''Transaction group'''
| |
| − | ! style="text-align:left;"| '''Transaction'''
| |
| − | ! style="text-align:left;"| '''Actor'''
| |
| − | ! style="text-align:left;"| '''Role'''
| |
| − | |-
| |
| − | |style="background-color: white;vertical-align:top;" rowspan="3"|Retrieve AllergyIntolerance(PULL)
| |
| − | |style="background-color: white;vertical-align:top;"|Retrieve AllergyIntolerance request
| |
| − | |style="background-color: white;vertical-align:top;"|Patient (using a PHR)
| |
| − | |style="background-color: white;vertical-align:top;"|Request allergy and intolerance information from the XIS
| |
| − | |-
| |
| − | |style="background-color: white;vertical-align:top;"|Retrieve AllergyIntolerance response
| |
| − | |style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
| |
| − | |style="background-color: white;vertical-align:top;"|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 [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.
| |
| − |
| |
| − | <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=====
| |
| − | 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 medication 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:
| |
| − | *[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. 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.
| |
| − | | |
| − | {{NoteBoxPackage|https://simplifier.net/packages/nictiz.fhir.nl.stu3.zib2017/1.0.0|1.0.0|MedMij:Vdraft_FHIR_IG}}
| |
| − | | |
| − | {| class="wikitable"
| |
| − | |-style="background-color: #1F497D; color: white; font-weight: bold; "
| |
| − | |ZIB name NL||ZIB name EN||FHIR Resource||URL profile
| |
| − | |-style="vertical-align:top; background-color: #E3E3E3;
| |
| − | |-
| |
| − | | Patient
| |
| − | | #ZIB Patient|Patient
| |
| − | | Patient
| |
| − | | [https://simplifier.net/NictizSTU3-Zib2017/nl-core-patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient]
| |
| − | |-
| |
| − | | Zorgverlener
| |
| − | | HealthProfessional
| |
| − | | Practitioner
| |
| − | | [https://simplifier.net/NictizSTU3-Zib2017/nl-core-practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner]
| |
| − | |-
| |
| − | | AllergieIntolerantie
| |
| − | | AllergyIntolerance
| |
| − | | AllergyIntolerance
| |
| − | | [https://simplifier.net/NictizSTU3-Zib2017/zib-AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance]
| |
| − | |}
| |
| − | | |
| − | ====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 medication 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.
| |
| − | | |
| − | =Annex: Document history=
| |
| − | ==Release notes==
| |
| − | {| class="wikitable" "cellpadding="10"
| |
| − | !style="text-align:left;"|Versie
| |
| − | !style="text-align:left;"|Datum
| |
| − | !style="text-align:left;"|BITS issue
| |
| − | !style="text-align:left;"|Omschrijving
| |
| − | |-
| |
| − | | style="background-color: white;"| 1.0.0
| |
| − | | style="background-color: white;"| 09 oktober 2018
| |
| − | | style="background-color: white;"| [https://bits.nictiz.nl/browse/MM-52 MM-52]
| |
| − | | style="background-color: white;"| AllergyIntolerantie filter op medicatieproces conditie geldigheidstermijn niet nodig
| |
| − | |}
| |
| − | | |
| − | ==History==
| |
| − | {| class="wikitable" "cellpadding="10"
| |
| − | !style="text-align:left;"|Version
| |
| − | !style="text-align:left;"|Date
| |
| − | !style="text-align:left;"|Description
| |
| − | |-
| |
| − | | style="background-color: white;"| 1.0.0
| |
| − | | style="background-color: white;"| 15-10-2018
| |
| − | | style="background-color: white;"| Added version in title, and document history
| |
| − | |}
| |
| − | | |
| − | | |
| − | [[categorie:MedMij FHIR Use Cases]]
| |
