Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
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 |
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 |
The AuditEvent resource is used to consolidate and track logging information within the Koppeltaal ecosystem. It captures details about system activities, data access, and interactions between applications for security and compliance purposes. |
| KT2_CareTeam |
The CareTeam resource represents a group of healthcare professionals and related persons who collaborate to provide coordinated care and treatment for a patient. It defines the roles and participants involved in delivering healthcare services within the Koppeltaal ecosystem. |
| KT2_Device |
The Device resource represents a software application or system that is used in the provision of healthcare services. Within the Koppeltaal context, this typically includes modules, portals, or eHealth applications that facilitate patient care and data exchange between healthcare systems. |
| KT2_Endpoint |
The Endpoint resource represents the technical contact point for an application that provides eHealth services. It defines the network address, connection protocols, and communication parameters necessary for systems to connect and interact with healthcare applications within the Koppeltaal ecosystem. |
| KT2_Organization |
The Organization resource represents a formally or informally recognized grouping of people or organizations that collectively provide healthcare services. This includes healthcare providers, departments, community groups, and healthcare practice groups operating within the Koppeltaal ecosystem. The profile extends the NlcoreHealthcareProviderOrganization profile with Koppeltaal-specific requirements. |
| KT2_Patient |
The Patient resource represents a person receiving healthcare services within the Koppeltaal ecosystem. Patients can be assigned eHealth activities and are the primary focus of care coordination between different healthcare applications. This profile extends the NlcorePatient profile with Koppeltaal-specific requirements. |
| KT2_Practitioner |
The Practitioner resource represents a healthcare professional who is directly or indirectly involved in the provision of patient care. This includes physicians, nurses, therapists, and other healthcare providers operating within the Koppeltaal ecosystem. The profile extends the NlcoreHealthProfessionalPractitioner profile, implementing Dutch Health Information Building Block (zib) standards. |
| KT2_RelatedPerson |
The RelatedPerson resource represents an individual who has a personal or professional relationship with a patient and may be involved in their care. This includes family members, caregivers, legal guardians, and other support persons who assist in the patient's therapy and treatment. The profile extends the NlcoreContactPerson profile with Koppeltaal-specific requirements. |
| KT2_Subscription |
The Subscription resource defines push-based notifications between systems in the Koppeltaal ecosystem. It enables applications to receive real-time updates when resources matching specified criteria are created or modified. The subscription mechanism ensures timely data synchronization and event-driven communication between healthcare applications. |
| KT2_Task |
The Task resource represents an eHealth activity that has been assigned to a specific patient. It tracks the lifecycle of patient assignments, from initial creation through completion, and may include subtasks for complex multi-step interventions. Tasks are created based on ActivityDefinition resources and managed throughout their execution within the Koppeltaal ecosystem. |
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. |
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 Expansion |
Optional expansions for Koppeltaal activities |
| Koppeltaal Task Code |
ValueSet for Task.code |
| Koppeltaal Usage Context Type |
Usage context type values for Koppeltaal ActivityDefinitions - uses standard FHIR usage context types |
| audit-event-type ValueSet |
ValueSet defining the allowed eventtypes for Koppeltaal |
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 Expansion |
Optional expansions for Koppeltaal activities |
| Koppeltaal Task Code |
Type of Task.code specifically used in Koppeltaal |
| Koppeltaal Usage Context Type |
Usage context type codes for Koppeltaal ActivityDefinitions, extending standard FHIR usage context types |
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 |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Mindfulness exercise for adults |
Example of an ActivityDefinition using standard FHIR useContext values (age and gender) |
| 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 |