Koppelmij Implementation Guide
0.1.0 - ci-build
Koppelmij Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-05-08 |
Definitions for the pt-lm-ActivityDefinition logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. pt-lm-ActivityDefinition | |
| Definition | Reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It describes the clinical intent and (when applicable) the technical launch details (e.g., endpoint) so that systems can create patient-specific workflow Tasks that reference this definition. Base definition for all elements in a resource. |
| Short | ActivityDefinitionBase for all elements |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | Module |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. pt-lm-ActivityDefinition.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. pt-lm-ActivityDefinition.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on pt-lm-ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. pt-lm-ActivityDefinition.ModuleEndpoint | |
| Definition | Endpoint that exposes the launchable activity. |
| Short | Endpoint that exposes the launchable activity. |
| Control | 0..1 |
| Type | Reference(Endpoint) |
| Alternate Names | Endpoint |
| 8. pt-lm-ActivityDefinition.Identifier | |
| Definition | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Short | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Control | 0..1 |
| Type | Identifier |
| 10. pt-lm-ActivityDefinition.Version | |
| Definition | Version identifier for this provider module, used to distinguish different published revisions. |
| Short | Version identifier for this provider module, used to distinguish different published revisions. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Versie |
| 12. pt-lm-ActivityDefinition.Name | |
| Definition | Name for this activity definition (computer friendly) |
| Short | Name for this activity definition (computer friendly) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Naam |
| 14. pt-lm-ActivityDefinition.Title | |
| Definition | Human-friendly title for display and selection. |
| Short | Human-friendly title for display and selection. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Titel |
| 16. pt-lm-ActivityDefinition.Status | |
| Definition | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Short | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Status |
| 18. pt-lm-ActivityDefinition.Publisher | |
| Definition | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Short | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. pt-lm-ActivityDefinition.Description | |
| Definition | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Short | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Omschrijving |
| 22. pt-lm-ActivityDefinition.Usage | |
| Definition | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Short | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Gebruik |
| 24. pt-lm-ActivityDefinition.Timing | |
| Definition | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Short | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Control | 0..1 |
| Type | Timing |
| Alternate Names | Tijdschema |
Guidance on how to interpret the contents of this table can be foundhere
| 0. pt-lm-ActivityDefinition | |
| Definition | Reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It describes the clinical intent and (when applicable) the technical launch details (e.g., endpoint) so that systems can create patient-specific workflow Tasks that reference this definition. |
| Short | ActivityDefinition |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | Module |
| 2. pt-lm-ActivityDefinition.ModuleEndpoint | |
| Definition | Endpoint that exposes the launchable activity. |
| Short | Endpoint that exposes the launchable activity. |
| Control | 0..1 |
| Type | Reference(Endpoint) |
| Alternate Names | Endpoint |
| 4. pt-lm-ActivityDefinition.Identifier | |
| Definition | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Short | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Control | 0..1 |
| Type | Identifier |
| 6. pt-lm-ActivityDefinition.Version | |
| Definition | Version identifier for this provider module, used to distinguish different published revisions. |
| Short | Version identifier for this provider module, used to distinguish different published revisions. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Versie |
| 8. pt-lm-ActivityDefinition.Name | |
| Definition | Name for this activity definition (computer friendly) |
| Short | Name for this activity definition (computer friendly) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Naam |
| 10. pt-lm-ActivityDefinition.Title | |
| Definition | Human-friendly title for display and selection. |
| Short | Human-friendly title for display and selection. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Titel |
| 12. pt-lm-ActivityDefinition.Status | |
| Definition | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Short | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Status |
| 14. pt-lm-ActivityDefinition.Publisher | |
| Definition | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Short | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. pt-lm-ActivityDefinition.Description | |
| Definition | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Short | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Omschrijving |
| 18. pt-lm-ActivityDefinition.Usage | |
| Definition | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Short | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Gebruik |
| 20. pt-lm-ActivityDefinition.Timing | |
| Definition | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Short | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Control | 0..1 |
| Type | Timing |
| Alternate Names | Tijdschema |
Guidance on how to interpret the contents of this table can be foundhere
| 0. pt-lm-ActivityDefinition | |
| Definition | Reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It describes the clinical intent and (when applicable) the technical launch details (e.g., endpoint) so that systems can create patient-specific workflow Tasks that reference this definition. |
| Short | ActivityDefinition |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | Module |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. pt-lm-ActivityDefinition.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. pt-lm-ActivityDefinition.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on pt-lm-ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. pt-lm-ActivityDefinition.ModuleEndpoint | |
| Definition | Endpoint that exposes the launchable activity. |
| Short | Endpoint that exposes the launchable activity. |
| Control | 0..1 |
| Type | Reference(Endpoint) |
| Alternate Names | Endpoint |
| 8. pt-lm-ActivityDefinition.Identifier | |
| Definition | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Short | Business identifier that uniquely identifies this ActivityDefinition instance within or across systems. |
| Control | 0..1 |
| Type | Identifier |
| 10. pt-lm-ActivityDefinition.Version | |
| Definition | Version identifier for this provider module, used to distinguish different published revisions. |
| Short | Version identifier for this provider module, used to distinguish different published revisions. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Versie |
| 12. pt-lm-ActivityDefinition.Name | |
| Definition | Name for this activity definition (computer friendly) |
| Short | Name for this activity definition (computer friendly) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Naam |
| 14. pt-lm-ActivityDefinition.Title | |
| Definition | Human-friendly title for display and selection. |
| Short | Human-friendly title for display and selection. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Titel |
| 16. pt-lm-ActivityDefinition.Status | |
| Definition | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Short | Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows. |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Status |
| 18. pt-lm-ActivityDefinition.Publisher | |
| Definition | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Short | Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. pt-lm-ActivityDefinition.Description | |
| Definition | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Short | Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific. |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Omschrijving |
| 22. pt-lm-ActivityDefinition.Usage | |
| Definition | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Short | Guidance on how this activity definition should be used in clinical workflows. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | Gebruik |
| 24. pt-lm-ActivityDefinition.Timing | |
| Definition | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Short | Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources. |
| Control | 0..1 |
| Type | Timing |
| Alternate Names | Tijdschema |