MedMij:V2020.01/FHIR GGZ: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
k (Tekst vervangen - "{{Simplifier\|([^\|}]+)\|([^(scope=)][^\|}]+)" door "{{Simplifier|$1|title=$2")
k (Beveiligde "MedMij:V2020.01/FHIR GGZ": Protect production page from accidental edits ([Bewerken=Alleen beheerders toestaan] (vervalt niet) [Hernoemen=Alleen beheerders toestaan] (vervalt niet)))
 
(31 tussenliggende versies door 5 gebruikers niet weergegeven)
Regel 1: Regel 1:
 
__NUMBEREDHEADINGS__
 
__NUMBEREDHEADINGS__
−
{{DISPLAYTITLE:MedMij FHIR Implementation Guide basic GGZ data {{VersieInfo|Vprepub|BgGGZ}}}}
+
{{DISPLAYTITLE:MedMij FHIR Implementation Guide basic GGZ data {{VersieInfo|BgGGZ}}}}
−
{{MedMij:Vprepub/Issuebox_FHIR_IG}}
+
{{MedMij:V2020.01/Issuebox_FHIR_IG}}
  
 
[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
 
[[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   
 
<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 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]                 
−
circle 1013 224 212 [[MedMij:Vprepub/OntwerpGGZ|Functioneel]]                 
+
circle 1013 224 212 [[MedMij:V2020.01/OntwerpGGZ|Functioneel]]                 
−
circle 1787 230 212 [[MedMij:Vprepub/FHIR_IG|Technisch]]                 
+
circle 1787 230 212 [[MedMij:V2020.01/FHIR_IG|Technisch]]                 
 
desc none                     
 
desc none                     
 
</imagemap>
 
</imagemap>
Regel 15: Regel 15:
  
 
=Introduction=
 
=Introduction=
−
The page describes the FHIR requirements for exchanging GGZ information between the patients and healthcare providers in the context of MedMij. The overarching FHIR requirements, described in the [[MedMij:Vprepub/FHIR_IG|technical IG guide homepage]], are applicable here.
+
The page describes the FHIR requirements for exchanging GGZ information between the patients and healthcare providers in the context of MedMij.
 +
 
 +
'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:V2020.01/FHIR_IG#Use case overarching principles|use case overarching principles]].
  
 
=Actors involved=
 
=Actors involved=
Regel 31: Regel 33:
 
|-
 
|-
 
| Patient
 
| Patient
−
| The user of a personal healthcare enviorment.
+
| The user of a personal healthcare environment.
 
| PHR
 
| PHR
 
| Personal health record
 
| Personal health record
−
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/ggz-clientcapabilities|title=CapabilityStatement: Client}}
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/ggz-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Client}}
 
| FHIR Client requirements  
 
| FHIR Client requirements  
 
|-
 
|-
Regel 41: Regel 43:
 
| XIS
 
| XIS
 
| Healthcare information system
 
| Healthcare information system
−
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/ggz-servercapabilities|title=CapabilityStatement: Server}}
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/ggz-servercapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Server}}
 
| FHIR Server requirements  
 
| FHIR Server requirements  
 
|}
 
|}
Regel 50: Regel 52:
  
 
=Use case: retrieve GGZ information=
 
=Use case: retrieve GGZ information=
−
==List of invocations==
+
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to MedMij Afsprakenstelsel]]
−
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
 
  
 
{{FHIR-IG-Afsprakenstelsel-Note}}
 
{{FHIR-IG-Afsprakenstelsel-Note}}
  
−
===Client - PHR===
+
===PHR: request message===
−
The PHR system requests the patient's GGZ information using individual search interactions over multiple FHIR resources. The client can use multiple individual search operations based on specified search queries. A search interaction can be performed by an HTTP GET or command as shown:
+
The PHR system requests the patients GGZ information using individual [https://www.hl7.org/fhir/stu3/search.html search] interactions. The BgGGZ consists of multiple FHIR resources with certain constraints. To obtain the patient's BgGGZ, the client can use multiple individual search operations based on specified search queries. The interactions are performed by an HTTP GET as shown:
  
−
<code>GET [base]/[type]/{?[parameters]{&_format=[mime-type]}}</code>
+
<code>GET [base]/[type]{?[parameters]}</code>
  
−
The table below shows in the first three columns the HCIM name in Dutch, in English and what HCIM content is requested. The last column shows the FHIR search queries to retrieve this information. The queries are based on the functional GGZ information exchange requirements, which are stated in the [https://informatiestandaarden.nictiz.nl/wiki/MedMij:Vdraft_OntwerpGGZ functional overview] and shown in detail in this [https://informatiestandaarden.nictiz.nl/wiki/MedMij:Vdraft_InhoudGGZ table]. The queries, and more profoundly the response messages follow the profiles listed in [[#List_of_StructureDefinitions| the list of StructureDefinition]] section. The response content shall conform to these StructureDefinitions.
+
The table below shows in the first three columns the HCIM name in Dutch, in English and what HCIM content is requested. The last column shows the FHIR search queries to obtain this information. These queries and expected responses are based on profiles listed in [[#List_of_profiles|this section]].
  
 
{| class="wikitable" style="horizontal-align: right"  
 
{| class="wikitable" style="horizontal-align: right"  
Regel 67: Regel 68:
 
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | HCIM EN
 
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | HCIM EN
 
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | Content
 
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | Content
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | Search URL
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | Search URL<ref>See [[MedMij:V2020.01/FHIR_IG#Search_URLs_and_search_parameters|Search URLs and search parameters]] for the interpretation of these search URLs</ref>
 
|-
 
|-
 
| Patient
 
| Patient
Regel 102: Regel 103:
 
| FreedomRestrictingMeasures
 
| FreedomRestrictingMeasures
 
| All known freedom restricting measures
 
| All known freedom restricting measures
−
| style="font-style:italic;" | see Procedure
+
| ''see Procedure''
 +
<span id="FunctionalOrMentalStatusRemark">{{IssueBox|Due to legislation (the 'Wet verplichte ggz' (Wvggz)) HCIM FreedomRestrictingMeasures-v3.1 (release 2017) has become obsolete. Therefore, this version of the BgGGZ will not require the use and exchange of this HCIM.
 +
}}</span>
 
|-
 
|-
 
| Contactpersoon
 
| Contactpersoon
Regel 113: Regel 116:
 
| All known functional / mental status
 
| All known functional / mental status
 
| <pre>GET [base]/Observation?category=http://snomed.info/sct|118228005,http://snomed.info/sct|384821006</pre>
 
| <pre>GET [base]/Observation?category=http://snomed.info/sct|118228005,http://snomed.info/sct|384821006</pre>
 +
<span id="FunctionalOrMentalStatusRemark"></span>{{NoteBox|The NL-CM:4.26.6 StatusDate concept is incorrectly mapped on the <code>effective[x]:effectivePeriod.start</code> element in the HCIM FunctionalOrMentalStatus profile, it is a date rather than a period. Presumed solution will come from a future HCIM release. See [https://bits.nictiz.nl/browse/MM-1570 MM-1570] for more information.}}
 
|-
 
|-
 
| Probleem
 
| Probleem
Regel 144: Regel 148:
 
| <pre>GET [base]/Observation?code=http://snomed.info/sct|365470003</pre>
 
| <pre>GET [base]/Observation?code=http://snomed.info/sct|365470003</pre>
 
|-
 
|-
−
| GezinssituatieKind
+
| GezinssituatieKind
 
| FamilySituationChild
 
| FamilySituationChild
 
| All known family situations of child patient
 
| All known family situations of child patient
−
| <pre>GET [base]/Observation?code=http://snomed.info/sct|55801000146105</pre>
+
| <pre>GET [base]/Observation?code=http://snomed.info/sct|55801000146105</pre> {{IssueBox|FamilySituationChild is not part of the required list by the VIPP GGZ regulation.}}
 
|-
 
|-
 
| Taalvaardigheid
 
| Taalvaardigheid
Regel 199: Regel 203:
 
| style="font-style:italic;" | see Patient, CareTeam
 
| style="font-style:italic;" | see Patient, CareTeam
 
|}
 
|}
 +
<references/>
  
 
===Server - XIS===
 
===Server - XIS===
−
Important sections of the FHIR specification for a server in this use case are the [http://hl7.org/fhir/STU3/http.html#2.21.0 RESTful API section] the [http://hl7.org/fhir/STU3/search.html search section].
+
The returned data to the PHR should conform to the profiles listed in [[#List_of_profiles]].
−
 
 
−
====Response to resource requests====
 
−
If the search succeeds, the server SHALL return a 200 OK HTTP status code and the returned content SHALL be a Bundle with type = searchset containing the results of the search as a collection of zero or more resources in a defined order. The returned content SHALL conform to the StructureDefinition applicable for the specific HCIM request. The list of a StructureDefinitions relevant for this use case is shown in the following paragraph: [[#List_of_StructureDefinitions | List of StructureDefinitions]]
 
−
 
 
−
The result collection can be long, so servers may use paging. If they do, they SHALL use the method described below (adapted from RFC 5005 (Feed Paging and Archiving ) for breaking the collection into pages if appropriate. The server MAY also return an [http://hl7.org/fhir/stu3/operationoutcome.html OperationOutcome resource] within the searchset Bundle entries that contains additional information about the search; if one is sent it SHALL NOT include any issues with a fatal or error severity, and it SHALL be marked with a Bundle.entry.search.mode of outcome.
 
−
 
 
−
In order to allow the client to be confident about what search parameters were used as criteria by the server, the server SHALL return the parameters that were actually used to process the search. Applications processing search results SHALL check these returned values where necessary. For example, if the server did not support some of the filters specified in the search, a client might manually apply those filters to the retrieved result set, display a warning message to the user or take some other action.
 
−
 
 
−
In the case of a RESTful search, these parameters are encoded in the self-link in the bundle that is returned:
 
−
<pre>
 
−
  <link>
 
−
    <relation value="self"/>
 
−
    <url value="http://example.org/Patient?identifier=[Patient-ID]/>
 
−
  </link>
 
−
</pre>
 
−
 
 
−
Link to the relevant FHIR specification: http://hl7.org/fhir/STU3/http.html#search
 
−
 
 
−
====Handling errors====
 
−
If the search fails '''(cannot be executed, not that there are no matches)''', the return value is a status code 4xx or 5xx with an OperationOutcome. An HTTP status code of 403 signifies that the server refused to perform the search, while other 4xx and 5xx codes signify that some sort of error has occurred. The HTTP status code 404 is returned if a XIS did not implement an endpoint used in a request by a PHR. When the search fails, a server SHOULD return an OperationOutcome detailing the cause of the failure. For example, in case of a not implemented FHIR endpoint, the OperationOutcome would state that the resource type is not supported. Note: an empty search result is not a failure.
 
−
 
 
−
Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues):
 
−
 
 
−
* 400 Bad Request - search could not be processed or failed basic FHIR validation rules
 
−
* 401 Not Authorized - authorization is required for the interaction that was attempted
 
−
* 404 Not Found - resource type not supported, or not a FHIR end-point
 
−
 
 
−
In some cases, parameters may cause an error. For instance:
 
−
 
 
−
* A parameter may refer to a non-existent resource e.g. <code>GET [base]/Observation?subject=101</code>, where "101" does not exist
 
−
* A parameter may refer to an unknown code e.g. <code>GET [base]/Observation?code=loinc|1234-1</code>, where the LOINC code "1234-1" is not known to the server
 
−
* A parameter may refer to a time that is out of scope e.g. <code>GET [base]/Condition?onset=le1995</code>, where the system only has data going back to 2001
 
−
* A parameter may use an illegal or unacceptable modifier e.g. <code>GET [base]/Condition?onset:text=1995</code>, where the modifier cannot be processed by the server
 
−
* A data time parameter may have incorrect format e.g. <code>GET [base]/Condition?onset=23%20May%202009</code>
 
−
* A parameter may be unknown or unsupported
 
−
Where the content of the parameter is syntactically incorrect, servers SHOULD return an error. However, where the issue is a logical condition (e.g. unknown subject or code), the server SHOULD process the search, including processing the parameter - with the result of returning an empty search set, since the parameter cannot be satisfied.
 
−
 
 
−
In such cases, the search process MAY include an OperationOutcome in the search set that contains additional hints and warnings about the search process. This is included in the search results as an entry with search mode = outcome. Clients can use this information to improve future searches.
 
−
 
 
−
Link to relevant FHIR specification: http://hl7.org/fhir/STU3/search.html#errors
 
−
 
 
−
==Interactions, operations, search parameters==
 
−
 
 
−
===Interactions===
 
−
 
 
−
The following logical interactions are needed for the GGZ use case:
 
−
* [http://hl7.org/fhir/STU3/http.html#search Search]
 
  
−
===Operations===
+
===The <code>lastn</code> operation===
 
The following [http://hl7.org/fhir/STU3/operations.html operation] is needed for this use case.
 
The following [http://hl7.org/fhir/STU3/operations.html operation] is needed for this use case.
 
* [http://hl7.org/fhir/STU3/observation-operations.html#lastn Last N Observations Query]
 
* [http://hl7.org/fhir/STU3/observation-operations.html#lastn Last N Observations Query]
  
−
The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results. The link will provide more detailed information and examples regarding this operation.
+
The <code>lastn</code> query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vital signs. The link will provide more detailed information and examples regarding this operation.
−
 
 
−
The FHIR STU3 specification is vague regarding the sorting mechanism of lastn. In FHIR R4 however, this has been clarified and can be read as follows: when using lastn, the effective[x] element is used for sorting of Observations, sorted from most recent to the oldest.
 
−
 
 
−
===Search parameters===
 
−
The following search parameter types and search result parameters need to be supported for this use case.
 
−
 
 
−
Search parameter types:
 
−
* [http://hl7.org/fhir/STU3/search.html#token token]
 
−
** Including modifier 'in'
 
−
* [http://hl7.org/fhir/STU3/search.html#reference reference]
 
  
−
Search result parameters:
+
The FHIR STU3 specification is vague regarding the sorting mechanism of <code>lastn</code>. In FHIR R4 however, this has been clarified and can be read as follows: when using <code>lastn</code>, the <code>effective[x]</code> element is used for sorting of Observations, sorted from most recent to the oldest.
−
* [http://hl7.org/fhir/STU3/search.html#include _include]
 
  
−
==List of StructureDefinitions==
+
==List of profiles==
 
The profiles represent their entire respective HCIM and are applicable in a broader context than the exchange of GGZ information.  
 
The profiles represent their entire respective HCIM and are applicable in a broader context than the exchange of GGZ information.  
  
−
{{NoteBoxPackage|https://simplifier.net/NictizSTU3-Zib2017/~packages|1.3.x|MedMij:Vprepub/FHIR_IG}}
+
{{MedMij:V2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1Min=2.0.0}}
  
 
{| class="wikitable" style="horizontal-align: right"  
 
{| class="wikitable" style="horizontal-align: right"  
Regel 283: Regel 230:
 
| Patient
 
| Patient
 
| Patient
 
| Patient
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Betaler
 
| Betaler
 
| Payer
 
| Payer
 
| Coverage
 
| Coverage
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Payer}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Payer|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| BehandelAanwijzing
 
| BehandelAanwijzing
 
| TreatmentDirective
 
| TreatmentDirective
 
| Consent
 
| Consent
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Wilsverklaring
 
| Wilsverklaring
 
| AdvanceDirective
 
| AdvanceDirective
 
| Consent
 
| Consent
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
|-
 
|-
Regel 304: Regel 251:
 
| LegalStatus*  
 
| LegalStatus*  
 
| Extension
 
| Extension
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-patient|see Patient}} or {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures|see FreedomRestrictingMeasures}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|see Patient}} <s> or {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures|nictiz.fhir.nl.stu3.zib2017|see FreedomRestrictingMeasures}} </s>
 
|-
 
|-
−
| VrijheidbeperkendeMaatregelen
+
| <s>VrijheidbeperkendeMaatregelen</s>
−
| FreedomRestrictingMeasures
+
| <s>FreedomRestrictingMeasures</s>
−
| Procedure
+
| <s>Procedure</s>
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures}}
+
| <s>{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures|nictiz.fhir.nl.stu3.zib2017}}</s>
 
|-
 
|-
 
| FunctioneleOfMentaleStatus
 
| FunctioneleOfMentaleStatus
 
| FunctionalOrMentalStatus
 
| FunctionalOrMentalStatus
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Probleem
 
| Probleem
 
| Problem
 
| Problem
 
| Condition
 
| Condition
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Problem}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Problem|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Woonsituatie
 
| Woonsituatie
 
| LivingSituation
 
| LivingSituation
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Druggebruik
 
| Druggebruik
 
| DrugUse
 
| DrugUse
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Alcoholgebruik
 
| Alcoholgebruik
 
| AlcoholUse
 
| AlcoholUse
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Tabakgebruik
 
| Tabakgebruik
 
| TobaccoUse
 
| TobaccoUse
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Gezinssituatie
 
| Gezinssituatie
 
| FamilySituation
 
| FamilySituation
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituation}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituation|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
−
| GezinssituatieKind
+
| <s> GezinssituatieKind </s>
−
| FamilySituationChild
+
| <s> FamilySituationChild </s>
−
| Observation
+
| <s> Observation </s>
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituationChild}}
+
| <s> {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituationChild|nictiz.fhir.nl.stu3.zib2017}} </s>
 
|-
 
|-
 
| Taalvaardigheid
 
| Taalvaardigheid
 
| LanguageProficiency
 
| LanguageProficiency
 
| Patient
 
| Patient
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-patient|see Patient}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|see Patient}}
 
|-
 
|-
 
| ParticipatieInMaatschappij
 
| ParticipatieInMaatschappij
 
| ParticipationInSociety
 
| ParticipationInSociety
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-ParticipationInSociety}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-ParticipationInSociety|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| HulpVanAnderen
 
| HulpVanAnderen
 
| HelpFromOthers
 
| HelpFromOthers
 
| CarePlan
 
| CarePlan
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-HelpFromOthers}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-HelpFromOthers|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| LaboratoriumUitslag
 
| LaboratoriumUitslag
 
| LaboratoryTestResult
 
| LaboratoryTestResult
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| AlgemeneMeting
 
| AlgemeneMeting
 
| GeneralMeasurement
 
| GeneralMeasurement
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Verrichting
 
| Verrichting
 
| Procedure
 
| Procedure
 
| Procedure
 
| Procedure
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Procedure}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Procedure|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| TekstUitslag
 
| TekstUitslag
 
| TextResult
 
| TextResult
 
| DiagnosticReport
 
| DiagnosticReport
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TextResult}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TextResult|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgverlener
 
| Zorgverlener
 
| HealthProfessional
 
| HealthProfessional
 
| Practitioner
 
| Practitioner
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgaanbieder
 
| Zorgaanbieder
 
| HealthProfessional
 
| HealthProfessional
 
| Organization
 
| Organization
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| -
 
| -
 
| -
 
| -
 
| CareTeam
 
| CareTeam
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-careteam}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-careteam|nictiz.fhir.nl.stu3.zib2017}}
 
|}
 
|}
−
<blockquote>* LegalStatus is a single concept of the HCIM FreedomRestrictingMeasures and does not represent a complete HCIM yet. This concept will become an indepentend HCIM in a future release of the HCIM.</blockquote>
+
<span id="FunctionalOrMentalStatusRemark">{{IssueBox|Due to legislation (the 'Wet verplichte ggz' (Wvggz)) HCIM FreedomRestrictingMeasures-v3.1 (release 2017) has become obsolete. Therefore, this version of the BgGGZ will not require the use and exchange of this HCIM.
−
{{Sjabloon:Voorbeelden}}
+
}}</span>
 +
<blockquote>* LegalStatus is a single concept of the HCIM FreedomRestrictingMeasures and does not represent a complete HCIM yet. This concept will become an independent HCIM in a future release of the HCIM.</blockquote>
  
−
=Terminology, NamingSystems, Mappings=
+
=Release notes=
−
 
+
Release notes can be found on the [[MedMij:V2020.01/OntwerpGGZ#Release_notes|functional design page]].
−
===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===
+
{{MedMij:Sjabloon_Support}}
−
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/OntwerpGGZ#Release_notes|functional design page]].
 

Huidige versie van 19 nov 2024 om 16:20



Naar medmij.nl
GGZ
AfsprakenstelselFunctioneelTechnischAfspraken-Functioneel-Technisch

1 Introduction

The page describes the FHIR requirements for exchanging GGZ information between the patients and healthcare providers in the context of MedMij.

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

2 Actors involved

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

3 Boundaries and Relationships

The GGZ use case has similarities and differences with other use cases such as the BgZ, Medication Process, Vital Signs, GP Patient Data and Lab Results. These use cases use much of the same HCIM based FHIR profiles for exchanging information. Wherever possible every attempt is made to re-use the profiles as used in the BgZ. The GGZ use case also has unique profiles compared to the aforementioned use cases. In addition, it has a CareTeam profile without an underlying HCIM. A second thing to note is that while the selection criteria of certain sections like procedure do not match with the BgZ or other use cases, this does not affect the profiles in use. For example, it is irrelevant for the response profile for procedures if you request ' surgical procedures' or 'every procedure'.

4 Use case: retrieve GGZ information

Go to MedMij Afsprakenstelsel

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.

4.1 PHR: request message

The PHR system requests the patients GGZ information using individual search interactions. The BgGGZ consists of multiple FHIR resources with certain constraints. To obtain the patient's BgGGZ, the client can use multiple individual search operations based on specified search queries. The interactions are performed by an HTTP GET as shown:

GET [base]/[type]{?[parameters]}

The table below shows in the first three columns the HCIM name in Dutch, in English and what HCIM content is requested. The last column shows the FHIR search queries to obtain this information. These queries and expected responses are based on profiles listed in this section.

HCIM NL HCIM EN Content Search URL[1]
Patient Patient Identification, birthdate, gender, deceasedindicator, contact details, marital status, legal status, and general practitioner (practitioner or organization) 
GET [base]/Patient?_include=Patient:general-practitioner
BurgerlijkeStaat MaritalStatus Known marital status see Patient
Betaler Payer Insurance information 
GET [base]/Coverage?_include=Coverage:payor:Patient&_include=Coverage:payor:Organization
BehandelAanwijzing TreatmentDirective All known treatment directives 
GET [base]/Consent?category=http://snomed.info/sct|11291000146105
Wilsverklaring AdvanceDirective All known advance directives 
GET [base]/Consent?category=http://snomed.info/sct|11341000146107
JuridischeStatus LegalStatus Known legal status see Patient and FreedomRestrictingMeasures procedure
VrijheidbeperkendeMaatregelen FreedomRestrictingMeasures All known freedom restricting measures see Procedure

Issue icon.png

Due to legislation (the 'Wet verplichte ggz' (Wvggz)) HCIM FreedomRestrictingMeasures-v3.1 (release 2017) has become obsolete. Therefore, this version of the BgGGZ will not require the use and exchange of this HCIM.

Contactpersoon Contact First relation/contact see Patient.contact
FunctioneleOfMentaleStatus FunctionalOrMentalStatus All known functional / mental status 
GET [base]/Observation?category=http://snomed.info/sct|118228005,http://snomed.info/sct|384821006

Em.png

The NL-CM:4.26.6 StatusDate concept is incorrectly mapped on the effective[x]:effectivePeriod.start element in the HCIM FunctionalOrMentalStatus profile, it is a date rather than a period. Presumed solution will come from a future HCIM release. See MM-1570 for more information.

Probleem Problem All known problems 
GET [base]/Condition
Druggebruik DrugUse All known drug use 
GET [base]/Observation?code=http://snomed.info/sct|228366006
Alcoholgebruik AlcoholUse All known alcohol use 
GET [base]/Observation?code=http://snomed.info/sct|228273003
Tabakgebruik TobaccoUse All known tobacco use 
GET [base]/Observation?code=http://snomed.info/sct|365980008
Woonsituatie LivingSituation Last known living situation 
GET [base]/Observation/$lastn?code=http://snomed.info/sct|365508006
Gezinssituatie FamilySituation All known family situations 
GET [base]/Observation?code=http://snomed.info/sct|365470003
GezinssituatieKind FamilySituationChild All known family situations of child patient 
GET [base]/Observation?code=http://snomed.info/sct|55801000146105

Issue icon.png

FamilySituationChild is not part of the required list by the VIPP GGZ regulation.

Taalvaardigheid LanguageProficiency Known language proficiency see Patient
ParticipatieInMaatschappij ParticipationInSociety All known participation in society status 
GET [base]/Observation?code=http://snomed.info/sct|314845004
HulpVanAnderen HelpFromOthers All known help from others 
GET [base]/CarePlan?category=http://snomed.info/sct|243114000
LaboratoriumUitslag LaboratoryTestResult Last known laboratory results per type (incl. medication levels like lithium) 
GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen
AlgemeneMeting GeneralMeasurement All known questionaire (for example HONOS, OQ-45, CQ index, 4DKL) outcome scores. 
GET [base]/Observation?category=http://hl7.org/fhir/observation-category|survey
Verrichting Procedure All known GGZ procedures (includes all known freedom restricting measures) 
GET [base]/Procedure
TekstUitslag TextResult All known text results of GGZ procedures 
GET [base]/DiagnosticReport
- - CareTeam: primary healthprofessional and other relevant healthprofessionals including the healthcare provider. 
GET [base]/CareTeam?_include=CareTeam:participant
Zorgverlener HealthProfessional General Practitioner of the patient see Patient, CareTeam
Zorgaanbieder HealthProvider General Practitioner's organization of the patient see Patient, CareTeam
  1. ↑ See Search URLs and search parameters for the interpretation of these search URLs

4.2 Server - XIS

The returned data to the PHR should conform to the profiles listed in #List_of_profiles.

4.3 The lastn operation

The following operation is needed for this use case.

The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vital signs. The link will provide more detailed information and examples regarding this operation.

The FHIR STU3 specification is vague regarding the sorting mechanism of lastn. In FHIR R4 however, this has been clarified and can be read as follows: when using lastn, the effective[x] element is used for sorting of Observations, sorted from most recent to the oldest.

4.4 List of profiles

The profiles represent their entire respective HCIM and are applicable in a broader context than the exchange of GGZ information.

Em.png

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:

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.

HCIM NL HCIM EN FHIR Resource FHIR Profile
Patient Patient Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Betaler Payer Coverage http://nictiz.nl/fhir/StructureDefinition/zib-Payer
BehandelAanwijzing TreatmentDirective Consent http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective
Wilsverklaring AdvanceDirective Consent http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective
JuridischeStatus* LegalStatus* Extension http://fhir.nl/fhir/StructureDefinition/nl-core-patient or http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures
VrijheidbeperkendeMaatregelen FreedomRestrictingMeasures Procedure http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures
FunctioneleOfMentaleStatus FunctionalOrMentalStatus Observation http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus
Probleem Problem Condition http://nictiz.nl/fhir/StructureDefinition/zib-Problem
Woonsituatie LivingSituation Observation http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation
Druggebruik DrugUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse
Alcoholgebruik AlcoholUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse
Tabakgebruik TobaccoUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse
Gezinssituatie FamilySituation Observation http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituation
GezinssituatieKind FamilySituationChild Observation http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituationChild
Taalvaardigheid LanguageProficiency Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
ParticipatieInMaatschappij ParticipationInSociety Observation http://nictiz.nl/fhir/StructureDefinition/zib-ParticipationInSociety
HulpVanAnderen HelpFromOthers CarePlan http://nictiz.nl/fhir/StructureDefinition/zib-HelpFromOthers
LaboratoriumUitslag LaboratoryTestResult Observation http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation
AlgemeneMeting GeneralMeasurement Observation http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement
Verrichting Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/zib-Procedure
TekstUitslag TextResult DiagnosticReport http://nictiz.nl/fhir/StructureDefinition/zib-TextResult
Zorgverlener HealthProfessional Practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
Zorgaanbieder HealthProfessional Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization
- - CareTeam http://fhir.nl/fhir/StructureDefinition/nl-core-careteam

Issue icon.png

Due to legislation (the 'Wet verplichte ggz' (Wvggz)) HCIM FreedomRestrictingMeasures-v3.1 (release 2017) has become obsolete. Therefore, this version of the BgGGZ will not require the use and exchange of this HCIM.

* LegalStatus is a single concept of the HCIM FreedomRestrictingMeasures and does not represent a complete HCIM yet. This concept will become an independent HCIM in a future release of the HCIM.

5 Release notes

Release notes can be found on the functional design page.


6 Support

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

Overgenomen van "https://informatiestandaarden.nictiz.nl/index.php?title=MedMij:V2020.01/FHIR_GGZ&oldid=234313"