skip to navigation
skip to content

koppeltaal 1.2.1

“Koppeltaal” (Ducth for “Connect language”) is a technical solution based on the international HL7/FHIR standard. It enables the exchange of e-health interventions. Koppeltaal enables organizations to connect e-health interventions from other providers to their own IT environment. With Koppeltaal organizations can more easily mix and match the best of the available e-health interventions and applications.


This connector acts as an intermediary or adapter between application and framework code and a Koppeltaal server. It is written in the Python programming language.


The initial development was done using Python 2.7. Python 3.6 compatibility work is being done.

This Koppeltaal connector was initially developed by Minddistrict Development B.V. for Stichting Koppeltaal.


The dependencies for the Koppeltaal Python connector is put together using [buildout].

On Linux/OSX, run:

`sh $ python2.7 $ bin/buildout `

On Windows, run (this works best in a git shell):

`sh $ C:\Python27\Python.exe $ bin\buildout.exe `


We use the [pytest] framework. The tests are run against a Koppeltaal server and domain setup specifically for testing the connector code base. This domain is called edge:

`sh $ bin/py.test --server=edge `

Command line interface

To use the koppeltaal connector command line interface:

`sh $ bin/koppeltaal --help `


The first argument to the koppeltaal script is the server to connect to, for example edge. The username, password and domain can be passed in as arguments or taken from ~/.koppeltaal.cfg. The format of ~/.koppeltaal.cfg looks like this:

` [edge] url = username = PA@PythonAdapterTesting4Edge password = <secret here> domain = PythonAdapterTesting `

Metadata / Conformance statement

To retrieve the Conformance statement from the server:

`sh $ bin/koppeltaal [servername] metadata `

Activity definition

To get the activity definition from the server:

`sh $ bin/koppeltaal [servername] activities `


To get a list of messages in the mailbox:

`sh $ bin/koppeltaal [servername] messages `

You can filter on a patient (with –patient), or event (with –event) or status (with –status):

`sh $ bin/koppeltaal [servername] messages --status=New --event=CreateOrUpdateCarePlan `

To get a specific message:

`sh $ bin/koppeltaal [servername] message [message URL or id] `

Python API

Use the following API in your integration code to talk to a Koppeltaal server:


[buildout]: [pytest]:

File Type Py Version Uploaded on Size
koppeltaal-1.2.1.tar.gz (md5) Source 2017-10-16 54KB