Koppeltaal 2.0 Implementation Guide
0.9.0 - ci-build Netherlands flag

Koppeltaal 2.0 Implementation Guide - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

correlation-id

Search correlationId for tracking audit events

participant

Find the participant of an ActivityDefinition

publisherId-extension

Search by publisherId for an ActivityDefinition

request-id

Search requestId for tracking audit events

resource-origin-extension

Search domain resources by resource-origin.

task-instantiates

Search Tasks based on a (set of) ActivityDefinition which in turn can conform to a specific PublisherId

trace-id

Search trace id for tracking audit events

Structures: Resource Profiles

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

KT2_ActivityDefinition

The (FHIR) ActivityDefinition (resource) describes an eHealth activity that is available for assignment to a patient. When assigning an eHealth activity to a patient, an eHealth Task is created, in which sub-activities are included as contained resources that refer to the main task via Task.partOf.

KT2_AuditEvent

Koppeltaal AuditEvent profile as used to consolidate logging information.

KT2_CareTeam

The care team of a patient that aids the patient in his/her treatment

KT2_Device

The (FHIR) Device (resource) is a representation of an application that is used in the provision of healthcare without being substantially changed through that activity. The device may be a module, portal or eHealth app.

KT2_Endpoint

The (FHIR) Endpoint (resource) is a representation of a technical contact point of an application that offers one or more eHealth services for a healthcare provider.

KT2_Organization

The (FHIR) Organization (resource) describes a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes also departments, community groups, healthcare practice groups, etc.

KT2_Patient

The (FHIR) Patient (resource) is a representation of a person who is being treated by the Healthcare Provider to whom eHealth activities are assigned.

KT2_Practitioner

The (FHIR) Practitioner (resource) is a representation of a person who is directly or indirectly involved in the provision of health care.

KT2_RelatedPerson

A related person is a person with a specific role and/or relationship to the patient to assist in the therapy

KT2_Subscription

The (FHIR) Subscription (resource) is used to define a push-based subscription from a server to another system. Once a Subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

KT2_Task

The (FHIR) Task (resource) describes an eHealth task, that is, an eHealth activity assigned to a patient.

Structures: Extension Definitions

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

KT2_CorrelationId

The correlation-id is an identifier related to the message and the workflow it's part of

KT2_EndpointExtension

Reference extension to the service application (endpoint) that provides the eHealth activity.

KT2_Instantiates

Extension added to a Task to refer to the ActivityDefinition which is instantiated by this Task

KT2_PublisherId

Identifier of the publisher (organization or individual). This extension is used as id in the ActivityDefinition.

KT2_RequestId

ID of the request. Together with the trace-id it uniquely identifies a request in logging

KT2_ResourceOrigin

Defines the author of the resource

KT2_TraceId

The ID of the workflow. The traceId is intended to track a log entry across multiple logs.

Terminology: Value Sets

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

Endpoint connection type ValueSet

Endpoint connection type ValueSet

Koppeltaal Definition Topic

High-level categorization of the definition, used for indicating special patient initialised activities

Koppeltaal Task Code

ValueSet for Task.code

audit-event-type ValueSet

ValueSet defining the allowed eventtypes for Koppeltaal

Terminology: Code Systems

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

COD472-VEKT Soort relatie cliënt

COD472-VEKT Soort relatie cliënt — uitsluitend bedoeld voor testdoeleinden!!! Dit is geen volledige lijst noch een door Vektis goedgekeurd uittreksel. Deze lijst is uitsluitend bedoeld voor testen binnen Koppeltaal.

Koppeltaal Definition Topic

High-level categorization of the definition, used for indicating special patient initialised activities

Koppeltaal Endpoint Connection Type

Type of endpoint connection as used in Koppeltaal

Koppeltaal Task Code

Type of Task.code specifically used in Koppeltaal

Terminology: Naming Systems

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

koppeltaal-client-id

Identifier system of the Devices as used within Koppeltaal

Example: Example Instances

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

Piekermoment (md)

Example of an ActivityDefinition that defines the use of a journal

Routine outcome monitoring

Vragenlijst ROM

Routine outcome monitoring

Example of an ActivityDefinition that defines a questionnaire

audit-event-with-outcome-4

Auditevent with OperationOutcome

auditEvent-fout-006

Example of an AuditEvent with an OperationOutcome indicating an error in the update

auditevent-create-patient

Example of an AuditEvent about creating a Patient

auditevent-delete-patient

Example of an AuditEvent about deleting a patient

auditevent-error-invalid-subscription

Auditevent with error about invalid subscription

auditevent-launch-application

Example of AuditEvent on application launch

auditevent-launch-example

Example of AuditEvent on user authentication

auditevent-with-outcome-4

Example of AuditEvent with create Operation resulting in outcome code 4

autorisatieserver

Example of Device indicating an authorisation server

ba33314a-795a-4777-bef8-e6611f6be645

Example of a Device

careteam-deelnemers

Example of CareTeam with multiple participants

careteam-minimaal

Example of bare minimum of CareTeam

careteam-related-person

Example of CareTeam that has a RelatedPerson as one of the participants

device-volledig

Example of a Device with all elements populated

endpoint123

Example of an Endpoint as used in Koppeltaal

nl-core-TreatmentDirective2-01-RelatedPerson-01

Nictiz Example of RelatedPerson only to test validation

organization-afdeling

Example of an Organization department

organization-minimaal

Bare minimum definition of an Organization

organization-naam-type

Example of an Organization with a name and type

patient-botje-minimaal

Bare minimum of Patient elements populated

patient-managingOrganization-telefoonnummer

Example of a Patient with a telephone number and managing organization

patient-met-resource-origin

Example of Patient with resource origin extension populated

patient-volledig-adres

Example of Patient with full address

patient-volledige-naam-bsn

Example of Patient with full name and address

patient-volledige-naam-vrouw

Example of Patient with full name and maiden name

patient-volledigenaam

Example of Patient with name and initials

practitioner-minimaal

Example of Practitioner

practitioner-volledig

Example of Practitioner with all elements populated

relatedperson-contactperson

The RelatedPerson is the contact person

relatedperson-example

RelatedPerson example

relatedperson-full

RelatedPerson multiple relationships

relatedperson-maximaal

RelatedPerson with as much elements filled in as possible

relatedperson-minimal

Example of a RelatedPerson (neighbour) 2

relatedperson-multiple-codes

RelatedPerson with multiple codes for relationship

relatedperson-neighbour

Example of a RelatedPerson (neighbour)

relatedperson-nictiz-example

Nictiz Example of RelatedPerson only to test validation

subscription-123

Example of a subscription

task-in-progress

Example of a task in progress

task-met-overkoepelende-task

Example of a sub task, part of another task

task-met-view-code

Task with view code set

task-minimaal

Example of a Task

task-overkoepelend

Example of an overarching task