Quality Assurance - Template - Technisch Ontwerp

1 Guidance

An Information Standard (IS) has both a functional and a technical specification, henceforth referred to by their Dutch abbreviations "FO" and "TO", respectively. This template describes both the standard structure and contents of a TO.
The template is annotated by the following:

• Goal: What the goal of the section is and what information it should include.
• Standard text: Standard sentences to include if appropriate.
• Examples: These are taken from multiple Nictiz ISs (BgZ-MSZ 2.0, eOverdracht, etc.).

Goal:
The Guidance chapter is used to give the reader general guidance regarding the technical implementation of the IS. It should include general disclaimers.

1.1 Support

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

1.2 Known issues

Standard text:
The IS described in this document is actively maintained and continuously improved. However, certain limitations may exist due to ongoing development, external dependencies, or the complexity of healthcare interoperability. These known issues are listed in the [Link-to-FO | FO (in Dutch)].

2 Introduction

Goal: To give general guidance to the reader.

Standard text:
This is the implementation guide (IG) for the information standard (IS) <IS-name>. This IG must be used together with the IS functional specification, see <link to <<IS>> main page>.

Example BgZ-MSZ 2.0 (FHIR STU3):
This is the FHIR implementation guide (IG) for the information standard BgZ-MSZ. This IG must be used together with the functional specification: see BgZ main page.

In addition, the guidelines as specified in general FHIR STU3 Implementation Guide apply. The guide defines how to implement FHIR STU3 and what rules apply (e.g. how to handle empty reponses etc.). In particular, the reader should take note of the use case overarching principles and the use of FHIR packages.

4 Workflow & transactions

MJ

Beginnen met aankaarten van "speciale workflows" (o.a. Notified Pull), als dit er is verwijzen naar de pagina's die de juiste info bevatten.

Diagrammen aangeven over welke flows doorlopen worden door de specifieke partijen - zoals bijvoorbeeld IHE dat doet in Technische ontwerp

6 Use-cases

In dit hoofdstuk wordt vanuit de gekozen techniek (e.g., FHIR) een technische uitwerking gegeven via invocations (e.g., FHIR queries). Een Transactie in ART-DECOR kun je zien als een maximaal bericht (die van toepassing is op meerdere use-cases). Via queries wordt de uitwisseling verder aangescherpt. Via optionele bereik parameters (e.g. lastn) kan voor meerdere use-cases in de gegevensuitwisseling worden voorzien.

FHIR query specificatie kan via een tabel met de volgende kolommen

1. . Query (inc gekozen resources)
2. . Code parameters
3. . Optionele 'bereik' parameters
4. . Relevante profielen
5. . toelichting

6.2 Example 2

6.2.1 Invocations

thema's als NP verdienen een specifiek hoofdstuk. De NP gaat 'horizontaal' door meerdere use cases.

7 Data exchange standard

The contents of this chapter change based on the chosen data exchange standard. Supported are HL7 FHIR, HL7 CDA, and HL7 v2.
Information included in this chapter:

• Artifacts - which artifacts are exchanged (e.g., FHIR profiles)?
• Artifacts - how do the HCIM's link to the artifacts?

7.1 HL7 FHIR

Every implementation of the standard will require the availability of the information presented here.

7.1.1 Artifacts

This section is to show the link between HCIM and FHIR resources. The table should follow the structure of the FO and refer to the FO (e.g., see FO).
For example, the link to the BgZ-MSZ 2.0 FO would be: [2.0 Chapter 2.1.1] In the BgZ 2.0 FO the data is sectioned off in chapters and sections. Therefore, the table would use the following headers:

1. Chapter - The relevant chapter from the FO.
2. HCIM - The name of the HCIM to be exchanged.
3. Target - The FHIR resource or data element used to exchange the specified HCIM.
4. Profile - The FHIR profile used in this information standard. Use Sjabloon Simplifier.

Tabel 1. Mapping table between a HCIM and a FHIR resource with a link to the profile specified by this information standard

Chapter	HCIM	Target	Profile
1	Patient	Patient	http://nictiz.nl/fhir/StructureDefinition/BgZ-Patient
	MaritalStatus	Patient.maritalStatus
2	BloodPressure	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure
	BodyWeight	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight
	BodyHeight	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight
3	LaboratoryTestResult	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation
		Specimen	http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Specimen
4	Procedure	Procedure	http://nictiz.nl/fhir/StructureDefinition/BgZ-Procedure
5	Encounter	Encounter	http://nictiz.nl/fhir/StructureDefinition/zib-Encounter

7.1.2 Examples of FHIR instances

A link to generated FHIR instances in the information standards' Nictiz-testscripts GitHub folder should be included. BgZ-MSZ 2.0 example: Nictiz-testscripts (BgZ-MSZ 2.0)

7.2 HL7 CDA

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

7.3 HL7 v2

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

9 Release notes (Not part of the template)

Release notes are not a part of the TO template because this information about the information standard 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