Netherlands - Generic Functions for data exchange Implementation Guide
0.3.0 - ci-build Netherlands flag

Netherlands - Generic Functions for data exchange Implementation Guide, published by Stichting Nuts. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nuts-foundation/nl-generic-functions-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Administration Directory for Administration Client

Dutch profile of the CapabilityStatement for Administration Directory Actor that should be able to work with an Administration Client

Administration Directory for Update Client

Dutch profile of the CapabilityStatement for Administration Directory Actor that should be able to work with an Update Client.

Localization Service

Dutch profile of the CapabilityStatement for a Localization Service.

Localization Service - Local Metadata Register

Dutch profile of the CapabilityStatement for a Localization Service - Local Metadata Register

Query Directory for Query Client

Dutch profile of the CapabilityStatement for Query Directory Actor that should be able to work with an Query Client.

Query Directory for Query Client for only Read operations

Dutch profile of the CapabilityStatement for Query Directory Actor that should be able to work with an Query Client for only Read operations.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

NL COW CancellationRequest Task

Sub-Task created by the Placer to request cancellation of a Coordination Task that has reached 'in-progress'. Until then the Placer may cancel directly by setting the Coordination Task status to 'cancelled'. The Fulfiller accepts or rejects the CancellationRequest Task; on acceptance the Placer sets the Coordination Task to 'cancelled'.

NL COW Coordination Task

Per-case Task hosted at the Placer that tracks the lifecycle of one Notified Pull order. Derived from the COW Coordination Task (identifier 1..*, businessStatus, code, focus on one of six order types are inherited). Task.for references the Patient at the Placer; Task.for.identifier carries the BSN once the Fulfiller may know it (per Fulfiller, per phase, as the use case defines).

NL COW Subscription

Broad, long-lived Subscription from a Placer to a Fulfiller for Notified Pull. One Subscription covers all Coordination Tasks for a single use-case topic between the two partners. Creation of the Subscription (in-band or out-of-band) is use-case defined; the Placer MUST check that a Subscription exists for the Fulfiller before notifying.

NL Generic Functions Endpoint Profile

The technical details of an endpoint that can be used for electronic services, such as for web services providing access to FHIR resources.

NL Generic Functions HealthcareService Profile

The technical details of a healthcare service that can be used in referrals, requests and orders

NL Generic Functions Localization DocumentReference Profile

A DocumentReference profile for registering the availability of patient data at healthcare organizations for localization services. This profile is used to indicate that certain patient data is available at a specific organization and can be accessed for localization purposes.

NL Generic Functions Location Profile

Physical location details for healthcare services, organizations, and practitioners.

NL Generic Functions Organization Profile

The organizational hierarchy and details for healthcare organizations.

NL Generic Functions Organization Profile

The organizational hierarchy and details for healthcare organizations.

NL Generic Functions OrganizationAffiliation Profile

The details of an affiliation/relationship between two organizations, such as a healthcare provider and a software vendor.

NL Generic Functions Practitioner Profile

The details of a healthcare practitioner, such as a doctor or nurse, who is directly or indirectly involved in the provisioning of healthcare.

NL Generic Functions PractitionerRole Profile

The details of a healthcare practitioner's role within an organization.

NL Generic Functions Task Profile for FHIR STU3

A task to be performed, such as a referral or order, with additional details specific to FHIR STU3.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

HealthcareService for Task in STU3

The healthcare service where the task is performed.

Location for Task in STU3

The location where the task is performed.

Supported ActivityDefinitions and PlanDefinitions by HealthcareServices

ActivityDefinitions or PlanDefinitions to specify the codeable concepts in HealthcareService.type.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

NL GF Data exchange capabilities

The data exchange capabilities supported by the NL Generic Functions.

NL GF WLZ Zorgprofielen ValueSet

The WLZ Zorgprofielen supported by the NL Generic Functions.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

NL COW Business Status

Business-status codes used by this profile that the COW business-status value set does not define. COW's workflow state overview uses selected without defining it.

NL GF Data exchange capabilities

Local code system for NL Generic Functions.

NL GF WLZ Zorgprofielen CodeSystem

Local code system for NL Generic Functions WLZ Zorgprofielen.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

pseudo-bsn

This Patient identifier represents a pseudonymized BSN.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

BgZ dataset — PlanDefinition (stub)

Nictiz-hosted canonical dataset definition for BgZ. Referenced from a referral's ServiceRequest via instantiatesCanonical. Shown as a stub; the production version enumerates ~30 queries.

Bundle of care services in ECD of Organization 3

This bundle contains all care services for the Organization 3 Administration Directory example

Bundle of care services in EHR of Organization 2

This bundle contains all care services for the Organization 2 Administration Directory example

Bundle of care services in HIS of Organization 1

This bundle contains all care services for the Organization 1 Administration Directory example

Bundle of care services in LRZa

This bundle contains all care services for the LRZa Administration Directory example

Bundle of care services in Query Directory

This bundle contains all care services from each Administration Directory for the Query Directory example

Bundle of personal health information in ECD of Organization 3

This bundle contains all personal health information for Patient Jaantje Merkens in Organization 3

Bundle of personal health information in EHR of Organization 2

This bundle contains all personal health information for Patient Jaantje Merkens in Organization 2

Bundle of personal health information in HIS of Organization 1

This bundle contains all personal health information for Patient Jaantje Merkens in Organization 1

Condition hypercalciëmie
Example NL Generic Functions Localization DocumentReference

Example instance of the NlGfLocalizationDocumentReference profile.

LRZa - Organization 1 - Endpoint
LRZa - Organization 1 - Endpoint
LRZa - Organization 1 - Organization
LRZa - Organization 1 - Organization
LRZa - Organization 2 - Endpoint
LRZa - Organization 2 - Endpoint
LRZa - Organization 2 - Organization
LRZa - Organization 2 - Organization
LRZa - Organization 3 - Endpoint
LRZa - Organization 3 - Endpoint
LRZa - Organization 3 - Organization
LRZa - Organization 3 - Organization
Notification bundle parameter for Care provider 33333333
Notification bundle with Task for Care provider 33333333 as owner
Organisation 2 - ServiceRequest Nursing

Request from Organization 2 for nursing care

Organization 1 - Endpoint
Organization 1 - Endpoint
Organization 1 - Organization
Organization 1 - Organization
Organization 1 - Practitioner Harry Arts
Organization 1 - Practitioner Harry Arts
Organization 1 - PractitionerRole Harry Arts
Organization 1 - PractitionerRole Harry Arts
Organization 2 - Endpoint DICOM-WADO-RS
Organization 2 - Endpoint DICOM-WADO-RS
Organization 2 - Endpoint FHIR R4
Organization 2 - Endpoint FHIR R4
Organization 2 - Endpoint FHIR STU3
Organization 2 - Endpoint FHIR STU3
Organization 2 - HealthcareService Cardiology
Organization 2 - HealthcareService Cardiology
Organization 2 - HealthcareService Geriatrie
Organization 2 - HealthcareService Geriatrie
Organization 2 - HealthcareService Interne Geneeskunde
Organization 2 - HealthcareService Interne Geneeskunde
Organization 2 - HealthcareService Neurochirurgie
Organization 2 - HealthcareService Neurochirurgie
Organization 2 - HealthcareService Orthopedie
Organization 2 - HealthcareService Orthopedie
Organization 2 - HealthcareService Urologie
Organization 2 - HealthcareService Urologie
Organization 2 - Organization
Organization 2 - Organization
Organization 2 - Practitioner Cardioloog Caroline van Dijk
Organization 2 - Practitioner Cardioloog Caroline van Dijk
Organization 2 - PractitionerRole Cardioloog Caroline van Dijk at Organization 2
Organization 2 - PractitionerRole Cardioloog Caroline van Dijk at Organization 2
Organization 2 - Task for ServiceRequest Nursing

Task created by Organization 2 to fulfill the ServiceRequest for nursing care at Nursing department at Organization 3

Organization 3 - Endpoint FHIR R4
Organization 3 - Endpoint FHIR R4
Organization 3 - Endpoint FHIR STU3
Organization 3 - Endpoint FHIR STU3
Organization 3 - HealthcareService Geriatrie
Organization 3 - HealthcareService Geriatrie
Organization 3 - HealthcareService Verpleging
Organization 3 - HealthcareService Verpleging
Organization 3 - Location Main Building
Organization 3 - Location Main Building
Organization 3 - Location Nursing Department
Organization 3 - Location Nursing Department
Organization 3 - Organization Nursing department

Nursing department at Organization 3

Organization 3 - Organization Nursing department

Nursing department at Organization 3

Organization 3 - Practitioner John Doe
Organization 3 - Practitioner John Doe
Organization 3 - PractitionerRole Klinisch Geriater John Doe
Organization 3 - PractitionerRole Klinisch Geriater John Doe
Organization 3- Organization
Organization 3- Organization
Patient Jaantje Merkens

Patient Jaantje Merkens in EHR of Organization 2

Referral — Coordination Task

Per-order workflow Task at the Placer. Task.for.identifier carries the BSN (the Placer chose to disclose it at creation); Task.input carries the trigger Observation and one supplemental query in addition to the BgZ dataset.

Referral — ServiceRequest

The Request resource describing what is ordered: a patient referral. instantiatesCanonical points at the BgZ dataset PlanDefinition. Per-order additions are on the Coordination Task.

Subscription at URA 22222222 for Task.owner URA 33333333

Subscription to receive notifications of Task-instance-id's where Care provider 33333333 is the (proposed) owner.

eOverdracht dataset — PlanDefinition (stub)

Nictiz-hosted canonical dataset definition for eOverdracht. Shown as a stub.

eOverdracht — Coordination Task (candidate A)

Coordination Task offering the transfer to Fulfiller A. Correlated with the task offered to Fulfiller B through the shared Task.focus.

eOverdracht — Coordination Task (candidate B)

Parallel Coordination Task offering the same ServiceRequest to Fulfiller B. Same Task.focus as candidate A. The Placer will select the first to accept, cancelling the other with statusReason 'not selected'.

eOverdracht — ServiceRequest

The transfer-of-care order. performer is intentionally absent: during solicitation the candidates are known via the Coordination Tasks (Task.owner), not via the ServiceRequest. performer MAY be set once a candidate is selected.