Quality Assurance - Template - Technisch Ontwerp

Uit informatiestandaarden
Ga naar: navigatie, zoeken
Under construction icon-blue.png This article or section is in the middle of an expansion or major restructuring and is not yet ready for use.

Back to Top

For an overview of all current documentation see <IS> main page


Processen: | Verkennen | Ontwikkelen & Testen | Publiceren | Beheren | Kwalificeren

Hoofdproces


Proceskaart Ontwikkelen Proceskaart Testen

Question icon.png

An Information Standard (IS) has both a functional and a technical design, henceforth referred to by their Dutch abbreviations "FO" and "TO", respectively. This template describes both the default structure and contents of a TO.

Change the document title to: Technical Design <IS name> <IS version>
The template uses the following annotation:

  • Goal: What the goal of the section is and what information it should include.
  • Default text: Sentences to include in the TO.
  • Examples: These are taken from multiple Nictiz ISs (BgZ-MSZ 2.0, eOverdracht, etc.).
  • Placeholders: "<" and ">" are used to denote places that should be filled with IS-specific information, like so: <example>.

1 Introduction

Lightbulb.svg

Goal: The Introduction is used to give the reader general guidance regarding the technical implementation of the IS. It should include general disclaimers.
Boundaries should define how organizations and their relationships are structured and exchanged across systems. It supports interoperability by standardizing hierarchical and functional links.

Default text: 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>.

Example: BgZ-MSZ 2.0 FHIR STU3 [expand/collapse]

1.1 Support

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

1.2 Boundaries

Default text: 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>.

Issue icon.png 

Dit moet ook in het FO template gezet worden!

1.3 Known issues

Default text: 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)].

Issue icon.png 

Dit moet ook in het FO template gezet worden!

1.4 Prerequisite knowledge

Default text: The following background information is required for understanding this TO:

  • The [[<link>| functional design <IS><version>]] 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 pattern <your pattern here>, which can be found here: [[<link>| <link name>]]

Example: BgZ-MSZ 2.0 [expand/collapse]


2 Components

Lightbulb.svg

Goal: This chapter should clarify how the data exchange format is used to accommodate the Dutch Clinical Information Models (Dutch abbreviation: zibs) and/or other building blocks used in the IS. The content of this chapter depends on the chosen data exchange format. Currently this template only supports HL7 FHIR. HL7v3 (including CDA), HL7v2, IHE XDS, IHE XCA and others are not supported yet.
The artifacts section should describe the link between zib and FHIR resources. The table should follow the structure of the FO and refer to the FO (bijv. zie FO).

Default text: <the data exchange format used e.g. HL7 FHIR, TA Notified Pull, XDS, XCA, CDA> is used to accommodate the Dutch Clinical Information Models (zibs) used in the IS.

2.1 HL7 FHIR <version>

Default text:

Em.png

<IS> 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:

  • [<link to package 1>]
  • [<link to package 2>]
  • [<link to package 3>]

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.

Example: eOverdracht 4.0.5 STU3 [expand/collapse]

2.1.1 Artifacts

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

zib FHIR resource FHIR profile
<zib 1> <FHIR resource 1> {{Simplifier|<canonical 1>|(package)(|pkgVersion=<package version 1>)(|title=<Simplifier page title 1>)}}
<zib 2> <FHIR resource 2> {{Simplifier|<canonical 2>|(package)(|pkgVersion=<package version 2>)(|title=<Simplifier page title 2>)}}


Example: BgZ-MSZ 2.0 FHIR STU3 [expand/collapse]

2.1.2 Examples of FHIR instances

Default text: You can find examples of FHIR-instances (filled-in FHIR profiles) in the Nictiz GitHub repository: [[<link to generated FHIR instances in the IS's Nictiz-testscripts GitHub folder> | <IS> Testscripts repository]].

Example: You can find examples of FHIR-instances (filled-in FHIR profiles) in the Nictiz GitHub repository: BgZ-MSZ 2.0 Testscripts repository


3 Transactions

Lightbulb.svg

Goal: In this chapter, the transaction groups of the functional design are supplemented with invocations, such as FHIR queries and search parameters.
The stakeholders of a transaction are called Actors. They can be persons or systems in different roles, such as the sending or receiving role.
To give an overview of the actors relevant in this IS, a table should be used to list the relevant actors, their systems, and, if possible, FHIR CapabilityStatements.

3.1 <Use case 1>

3.1.1 Involved actors

Default text:

Transaction group Transaction Actor System role code FHIR CapabilityStatement
<Transaction group name> <Transaction 1> <Actor 1> <SRC 1> <FCSN link 1>
<Transaction 2> <Actor 2> <SRC 2> <FCSN link 2>
Abbreviations: SRC = system role code, FCSN = FHIR CapabilityStatement Name.


Example: MedMij LaboratoryResults 2.0.42 FHIR STU3 [expand/collapse]:

3.1.2 Search parameters

Lightbulb.svg

Goal: Search parameters are used in the FHIR query URL to filter the results. Clients are obliged to use FHIR search parameters, but are not limited to these parameters.
Provide a table listing all search parameters that SHALL be supported for processing by servers and SHALL be supported by clients. Include the corresponding IS FHIR search parameter, a description of this parameter, relevant FHIR resources, and examples of its use. If your IS uses custom search parameters, they may be defined for transactions.

Default text:

FHIR Search Parameter Description FHIR Resource Example
<Functional building block 1>
<FHIR Search Parameter 1> <Description of FHIR Search Parameter 1> <FHIR Resource 1> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>
<Functional building block 2>
<FHIR Search Parameter 2> <Description of FHIR Search Parameter 2> <FHIR Resource 2> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>
<Functional building block 3>
<FHIR Search Parameter 3> <Description of FHIR Search Parameter 3> <FHIR Resource 3> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>
Use this caption for extra notes, abbreviations, etc.


Issue icon.png

WARNING: The following examples are outdated.

Example: BgZ-MSZ 2.0 STU3 [expand/collapse]


Example: MP9 R4 3.0.0-rc.1 [expand/collapse]

3.2 <Use case 2>

3.2.1 Involved actors

Default text:

Transaction group Transaction Actor System role code FHIR CapabilityStatement
<Transaction group name> <Transaction 1> <Actor 1> <System role code 1> <FHIR CapabilityStatement 1>
<Transaction 2> <Actor 2> <System role code 2> <FHIR CapabilityStatement 2>

3.2.2 Search parameters

Default text:

FHIR Search Parameter Description FHIR Resource Example
<Functional building block 1>
<FHIR Search Parameter 1> <Description of FHIR Search Parameter 1> <FHIR Resource 1> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>
<Functional building block 2>
<FHIR Search Parameter 2> <Description of FHIR Search Parameter 2> <FHIR Resource 2> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>
<Functional building block 3>
<FHIR Search Parameter 3> <Description of FHIR Search Parameter 3> <FHIR Resource 3> 
 <HTTP Method> [base]/<FHIR resource>?_include=<FHIR resource>:<Search parameters>


4 Optional elements (not part of template)

Lightbulb.svg

Goal: The contents of these chapters are dependent on the needs of your IS; fill them in at your own discretion.

4.1 Workflow

If absolutely necessary (e.g., your IS uses a workflow with a unique technical implementation), an additional chapter called "Workflow" may be added after the Introduction.

Example: eOverdracht Workflow chapter

4.2 Relationships

You may want to illustrate the relationships between the various data elements in your IS using a diagram. If so, add an additional chapter called "Relationships" after the Introduction (or Workflow, if used).

Example: Geboortezorg Relationships chapter

4.3 Footnotes

If absolutely necessary, an additional chapter called "Footnotes" may be added as the final chapter. In there, a footnote may be added using <ref> and ‎<references /> tags.

Example: Medication Process Footnotes chapter


Footnotes from examples in this template: ‎
  1. ↑ Omhoog naar: 1,0 1,1 This search parameter only needs to be supported when patient identification requires the use of search parameters, see section 2.4.
  2. ↑ Omhoog naar: 2,0 2,1 2,2 The search parameter consists of a custom FHIR search parameter not represented in the FHIR specification. Note that for MedicationRequest.category and MedicationStatement.category a core search parameter is available, hence no custom one is needed in those cases.
  3. Omhoog ↑ Chained search parameter: searches the medicationReference required in each building block for its .code.
  4. Omhoog ↑ For the MedicationRequest and MedicationDispense resource types, the period-of-use parameter searches on the ext-TimeInterval.Period extension which may include the ext-TimeInterval.Duration extension. For the MedicationStatement resource type, the parameter modifies the core search parameter on .effective to include the ext-TimeInterval.Duration extension that may be present.

5 Template wiki code (not part of template)

Lightbulb.svg

Goal: This chapter is here to have an empty template (without annotations and examples but including default text) to copy and reuse. 

<!-- LINK BACK to the information standard's main page (landingspagina) -->
<big>For an overview of all current documentation [[Landingspagina_IS| see <IS> main page]]</big>
<!-- END LINK BACK -->

<!-- TABLE OF CONTENTS showing only 1st en 2nd level headers -->
__NUMBEREDHEADINGS__
__TOC__
<!-- END TABLE OF CONTENTS -->

<!-- STOP INDEXING this page: makes this page invisible to search engines -->
__NOINDEX__
<!-- 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 ==
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>.

=== Support ===
For questions, feedback, or change requests, please contact our support team at [https://nictiz.atlassian.net/servicedesk/customer/portal/4 Nictiz Servicemanagement].

=== 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>.

=== 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)].

=== Prerequisite knowledge ===
The following background information is required for understanding this TO:
* The [[<link>| functional design <IS><version>]] 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 pattern <your pattern here>, which can be found here: [[<link>| <link name>]]


== 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 <version> ===

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

{| style="text-align: left;" cellpadding=5px;

|- style="color: white; background-color: #e7844b;"
! zib !! Target !! Profile

|-  style="background-color: #fcf0e9;"
| <zib 1> || <FHIR resource 1> || {{Simplifier|<canonical 1>|(package)(|pkgVersion=<package version 1>)(|title=<Simplifier page title 1>)}}

|-  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 ====
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]]. 


== Transactions ==
=== <Use case 1> ===
==== Involved actors ====
'''Default text:'''
{| 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> || <SRC 1> || <FCSN link 1>

|- style="background-color: #fcf0e9;"
| <Transaction 2> || <Actor 2> || <SRC 2> || <FCSN link 2>

|+ 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 ====
{| 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;"
| <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;"
| <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>
|}


6 Release notes (not part of template)

Lightbulb.svg

Goal: Release notes are not a part of the TO template because this information about the IS should already be available in the FO. This is described in the Kwaliteitshandboek Standaardisatie - Stappenplan patchrelease. Moreover, release notes for technical implementation are already published in the Nictiz Simplifier packages and GitHub pages.

In onderstaande tabel staan alle wijzigingen met betrekking tot dit Quality Assurance (QA) Proces, vanaf versie 3.0.0.

Versie Datum Release notes
1.0.0 16-07-2025 Finished first version
Overgenomen van "https://informatiestandaarden.nictiz.nl/index.php?title=qa:Template_TO&oldid=276368"