gpi:V1.0 TechnischOntwerp GPI: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
(Nieuwe pagina aangemaakt met '{{DISPLAYTITLE:Technisch ontwerp General Patient Information {{VersieInfo|GPI|release=V1.0|namespace=gpi}} }} <!-- LINK BACK to the information standard's main page...')
 
(Transactions: Added GitHub link to CapabilityStatement)
 
(22 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
 +
<!-- BACK TO TOP BUTTON -->
 +
<span id="BackToTop"></span>
 +
<div class="noprint" style="position:fixed; bottom:0%; left:3%; padding:0; margin:0;">
 +
[[Bestand:BackToTopNictizOrange.svg|64px|64px|link=#BackToTop|Back to Top]]
 +
</div>
 +
<!-- END BACK TO TOP BUTTON -->
 +
{{underconstruction}}
 
{{DISPLAYTITLE:Technisch ontwerp General Patient Information {{VersieInfo|GPI|release=V1.0|namespace=gpi}} }}
 
{{DISPLAYTITLE:Technisch ontwerp General Patient Information {{VersieInfo|GPI|release=V1.0|namespace=gpi}} }}
 
<!-- LINK BACK to the information standard's main page (landingspagina) -->
 
<!-- LINK BACK to the information standard's main page (landingspagina) -->
Regel 12: Regel 19:
 
__NOINDEX__
 
__NOINDEX__
 
<!-- END DON'T INDEX -->
 
<!-- END DON'T INDEX -->
 
<!-- BACK TO TOP BUTTON -->
 
<span id="BackToTop"></span>
 
<div class="noprint" style="position:fixed; bottom:2%; right:0.5%; padding:0; margin:0;">
 
[[Bestand:BackToTopNictizOrange.svg|80px|80px|link=#BackToTop|Back to Top]]
 
</div>
 
<!-- END BACK TO TOP BUTTON -->
 
  
 
== Introduction ==
 
== Introduction ==
This is the technical design (TO) for the information standard (IS) <IS name>. This TO must be used together with the IS functional design [[<link>| functional design <IS><version>]]. The data exchange format used in this version is: <HL7 CDA | FHIR STU3 | FHIR R4>.
+
This is the technical design (TO) for the information standard (IS) General Patient Information (GPI).
  
 
=== Support ===
 
=== Support ===
Regel 27: Regel 27:
  
 
=== Boundaries ===
 
=== Boundaries ===
This information standard may overlap with other standards related to identification, roles, and geographic classifications, requiring careful alignment to ensure consistency and avoid duplication. For more information, see <link to FO accompanying this TO>.
+
This information standard may overlap with other standards related to identification, roles, and geographic classifications, requiring careful alignment to ensure consistency and avoid duplication. <br>
 +
For more information, see the [https://informatiestandaarden.nictiz.nl/wiki/gpi:V1.0_Ontwerp_GPI GPI functional design (FO in Dutch) page].
  
 
=== Known issues ===
 
=== Known issues ===
The IS is actively maintained and continuously improved. However, issues may be discovered, which are listed in the [<Link-to-FO#known-issues> | FO (in Dutch)].
+
The IS is actively maintained and continuously improved. However, issues may be discovered, which are listed in the [[gpi:V1.0_Ontwerp_GPI#Known_issues| FO "Known issues"-section]].
  
 
=== Prerequisite knowledge ===
 
=== Prerequisite knowledge ===
 
The following background information is required for understanding this TO:
 
The following background information is required for understanding this TO:
* The [[<link>| functional design <IS><version>]] accompanying this TO.
+
* The [[gpi:V1.0_Ontwerp_GPI| Functional Design (FO)]] accompanying this TO.
* The data exchange format <your data exchange format here, e.g., FHIR STU3>, which you can find here: [[<link>| <link name>]]
+
* The data exchange format [https://hl7.org/fhir/R4/ HL7 FHIR R4].
* The data exchange pattern <your pattern here>, which can be found here: [[<link>| <link name>]]
 
 
 
  
 
== Components ==
 
== Components ==
<The data exchange format used, e.g., HL7 FHIR, TA Notified Pull, XDS, XCA, CDA> is used to accommodate the zibs used in the IS.  
+
HL7 FHIR R4 is used to accommodate the zibs used in this information standard.  
  
=== HL7 FHIR <version> ===
+
=== HL7 FHIR R4 ===
  
 
==== Artifacts ====
 
==== Artifacts ====
Regel 53: Regel 52:
  
 
|-  style="background-color: #fcf0e9;"
 
|-  style="background-color: #fcf0e9;"
| <zib 1> || <FHIR resource 1> || {{Simplifier|<canonical 1>|(package)(|pkgVersion=<package version 1>)(|title=<Simplifier page title 1>)}}
+
| Patient || Patient || {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient|nictiz.fhir.nl.r4.nl-core|pkgVersion={{VersieInfo|nictiz.fhir.nl.r4.nl-core|release=V1.0|namespace=gpi}}}}
  
|-  style="background-color: #fcf0e9;"
 
| <zib 2> || <FHIR resource 2> || {{Simplifier|<canonical 2>|(package)(|pkgVersion=<package version 2>)(|title=<Simplifier page title 2>)}}
 
 
|}
 
|}
 
  
 
==== Examples of FHIR instances ====
 
==== Examples of FHIR instances ====
You can find examples of FHIR instances (filled-in FHIR profiles) in the Nictiz GitHub repository: [[<link to generated FHIR instances in the IS'sdefault Nictiz-testscripts GitHub folder> | <IS> Testscripts repository]].  
+
You can find examples of FHIR instances (filled-in FHIR profiles) in the [https://github.com/Nictiz/HL7-mappings/tree/master/ada_2_fhir-r4/nl-ps-gpi/1.0/registration/fhir_instance Nictiz GitHub repository].
 
 
  
 
== Transactions ==
 
== Transactions ==
=== <Use case 1> ===
+
=== Sending ===
 
==== Involved actors ====
 
==== Involved actors ====
 
'''Default text:'''
 
'''Default text:'''
Regel 71: Regel 66:
  
 
|- style="color: white; background-color: #e7844b;"
 
|- style="color: white; background-color: #e7844b;"
! Transaction group || Transaction || Actor || System role code || FHIR CapabilityStatement
+
! Transaction || Actor || System role code || FHIR CapabilityStatement
 
 
|- style="background-color: #fcf0e9;"
 
| rowspan="2" | <Transaction group name>
 
| <Transaction 1> || <Actor 1> || <SRC 1> || <FCSN link 1>
 
  
 
|- style="background-color: #fcf0e9;"
 
|- style="background-color: #fcf0e9;"
| <Transaction 2> || <Actor 2> || <SRC 2> || <FCSN link 2>
+
| Sending || Sending-Server || Sending-Server || [https://github.com/Nictiz/Nictiz-R4-GPI/blob/main/CapabilityStatements/CapabilityStatement-gpi-retrieveServe.xml Nictiz GitHub: CapabilityStatement-gpi-retrieveServer.xml]
 
 
|+ style="align: bottom; caption-side: bottom; text-align: left;" | ''Abbreviations: SRC = system role code, FCSN = FHIR CapabilityStatement Name.''
 
 
|}
 
|}
 
 
<div style="background-color:aliceblue;padding:5px;">
 
'''Example:''' MedMij LaboratoryResults 2.0.42 FHIR STU3 [<span style="color:navy" class="mw-customtoggle-involvedActorsExample">expand/collapse</span>]:
 
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-involvedActorsExample">
 
{| style="text-align: left;  background-color: white;" cellpadding=5px;
 
 
|- style="color: white; background-color: #e7844b;"
 
! Transaction group !! Transaction !! Actor !! System role !! FHIR CapabilityStatement
 
 
|- style="background-color: #fcf0e9;"
 
| rowspan="2" | [https://decor.nictiz.nl/pub/medicatieproces/mp-html-20250522T132618/sc-2.16.840.1.113883.2.4.3.11.60.20.77.3.139-2022-06-30T000000.html#_2.16.840.1.113883.2.4.3.11.60.20.77.4.375_20220630000000 Medication data (PUSH)]
 
| [https://decor.nictiz.nl/pub/medicatieproces/mp-html-20250522T132618/tr-2.16.840.1.113883.2.4.3.11.60.20.77.4.376-2022-06-30T000000.html Sending medication data]
 
| Client
 
| MP-MGS
 
| rowspan="2" | {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/mp-MedicationData.SendReceive|nictiz.fhir.nl.r4.medicationprocess9|pkgVersion={{VersieInfo|nictiz.fhir.nl.r4.medicationprocess9|release=V3.0.0}}|title=Send/receive medication data}}
 
 
|- style="background-color: #fcf0e9;"
 
| Receiving medication data
 
| Server
 
| MP-MGO
 
 
|+ style="align: bottom; caption-side: bottom; text-align: left;" | ''Abbreviations: MP-MGS = Medicatieproces - medicatiegegevens sturend systeem, MP-MGO = Medicatieproces - medicatiegegevens ontvangend systeem.''
 
|}</div></div>
 
  
 
==== Search parameters ====
 
==== Search parameters ====
Regel 113: Regel 78:
  
 
|- style="color: white; background-color: #eda778;"
 
|- style="color: white; background-color: #eda778;"
! colspan="4"  | <Functional building block 1>
+
! colspan="4"  | Patient
 
 
|- style="background-color: #fcf0e9;"
 
| <FHIR Search Parameter 1> || <Description of FHIR Search Parameter 1> || <FHIR Resource 1> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
 
 
 
|- style="color: white; background-color: #eda778;"
 
! colspan="4" | <Functional building block 2>
 
 
 
|- style="background-color: #fcf0e9;"
 
| <FHIR Search Parameter 2> || <Description of FHIR Search Parameter 2> || <FHIR Resource 2> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
 
 
 
|- style="color: white; background-color: #eda778;"
 
! colspan="4" | <Functional building block 3>
 
 
 
|- style="background-color: #fcf0e9;"
 
| <FHIR Search Parameter 3> || <Description of FHIR Search Parameter 3> || <FHIR Resource 3> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
 
 
 
|+ style="align: bottom; caption-side: bottom; text-align: left;" | ''Use this caption for extra notes, abbreviations, etc.''
 
|}
 
 
 
 
 
=== <Use case 2> ===
 
==== Involved actors ====
 
{| style="text-align: left;" cellpadding=5px;
 
|- style="color: white; background-color: #e7844b;"
 
! Transaction group !! Transaction !! Actor !! System role code !! FHIR CapabilityStatement
 
 
 
|- style="background-color: #fcf0e9;"
 
| rowspan="2" | <Transaction group name>
 
| <Transaction 1> || <Actor 1> || <System role code 1> || <FHIR CapabilityStatement 1>
 
 
 
|- style="background-color: #fcf0e9;"
 
| <Transaction 2> || <Actor 2> || <System role code 2> || <FHIR CapabilityStatement 2>
 
|}
 
 
 
==== Search parameters ====
 
{| style="text-align: left;" cellpadding=5px;
 
|- style="color: white; background-color: #e7844b;"
 
! FHIR Search Parameter || Description || FHIR Resource || Example
 
 
 
|- style="color: white; background-color: #eda778;"
 
! colspan="4"  | <Functional building block 1>
 
  
 
|- style="background-color: #fcf0e9;"
 
|- style="background-color: #fcf0e9;"
| <FHIR Search Parameter 1> || <Description of FHIR Search Parameter 1> || <FHIR Resource 1> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
+
| patient || Retrieve general patient information from a FHIR server. || Patient || <pre> GET [base]/Patient </pre>
  
|- style="color: white; background-color: #eda778;"
 
! colspan="4" | <Functional building block 2>
 
 
|- style="background-color: #fcf0e9;"
 
| <FHIR Search Parameter 2> || <Description of FHIR Search Parameter 2> || <FHIR Resource 2> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
 
 
|- style="color: white; background-color: #eda778;"
 
! colspan="4" | <Functional building block 3>
 
 
|- style="background-color: #fcf0e9;"
 
| <FHIR Search Parameter 3> || <Description of FHIR Search Parameter 3> || <FHIR Resource 3> || <pre> <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters> </pre>
 
 
|}
 
|}

Huidige versie van 10 sep 2025 om 14:13

Back to Top

For an overview of all current documentation see GPI main page



1 Introduction

This is the technical design (TO) for the information standard (IS) General Patient Information (GPI).

1.1 Support

For questions, feedback, or change requests, please contact our support team at Nictiz Servicemanagement.

1.2 Boundaries

This information standard may overlap with other standards related to identification, roles, and geographic classifications, requiring careful alignment to ensure consistency and avoid duplication.
For more information, see the GPI functional design (FO in Dutch) page.

1.3 Known issues

The IS is actively maintained and continuously improved. However, issues may be discovered, which are listed in the FO "Known issues"-section.

1.4 Prerequisite knowledge

The following background information is required for understanding this TO:

2 Components

HL7 FHIR R4 is used to accommodate the zibs used in this information standard.

2.1 HL7 FHIR R4

2.1.1 Artifacts

The artifacts of the information standard are presented in the following table:

zib Target Profile
Patient Patient http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient

2.1.2 Examples of FHIR instances

You can find examples of FHIR instances (filled-in FHIR profiles) in the Nictiz GitHub repository.

3 Transactions

3.1 Sending

3.1.1 Involved actors

Default text:

Transaction Actor System role code FHIR CapabilityStatement
Sending Sending-Server Sending-Server Nictiz GitHub: CapabilityStatement-gpi-retrieveServer.xml

3.1.2 Search parameters

FHIR Search Parameter Description FHIR Resource Example
Patient
patient Retrieve general patient information from a FHIR server. Patient
 GET [base]/Patient