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

Logical Model: LmActivityDefinition - Detailed Descriptions

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.

ShortActivityDefinitionBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Alternate NamesModule
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on pt-lm-ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. pt-lm-ActivityDefinition.ModuleEndpoint
    Definition

    Endpoint that exposes the launchable activity.

    ShortEndpoint that exposes the launchable activity.
    Control0..1
    TypeReference(Endpoint)
    Alternate NamesEndpoint
    8. pt-lm-ActivityDefinition.Identifier
    Definition

    Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.

    ShortBusiness identifier that uniquely identifies this ActivityDefinition instance within or across systems.
    Control0..1
    TypeIdentifier
    10. pt-lm-ActivityDefinition.Version
    Definition

    Version identifier for this provider module, used to distinguish different published revisions.

    ShortVersion identifier for this provider module, used to distinguish different published revisions.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesVersie
    12. pt-lm-ActivityDefinition.Name
    Definition

    Name for this activity definition (computer friendly)

    ShortName for this activity definition (computer friendly)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesNaam
    14. pt-lm-ActivityDefinition.Title
    Definition

    Human-friendly title for display and selection.

    ShortHuman-friendly title for display and selection.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesTitel
    16. pt-lm-ActivityDefinition.Status
    Definition

    Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.

    ShortStatus of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesStatus
    18. pt-lm-ActivityDefinition.Publisher
    Definition

    Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.

    ShortOrganization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.
    Control0..1
    Typestring
    Primitive ValueThis 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.

    ShortHuman-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.
    Control0..1
    Typemarkdown
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesOmschrijving
    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.

    ShortGuidance 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.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesGebruik
    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.

    ShortRecommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources.
    Control0..1
    TypeTiming
    Alternate NamesTijdschema

    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.

    ShortActivityDefinition
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    Alternate NamesModule
    2. pt-lm-ActivityDefinition.ModuleEndpoint
    Definition

    Endpoint that exposes the launchable activity.

    ShortEndpoint that exposes the launchable activity.
    Control0..1
    TypeReference(Endpoint)
    Alternate NamesEndpoint
    4. pt-lm-ActivityDefinition.Identifier
    Definition

    Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.

    ShortBusiness identifier that uniquely identifies this ActivityDefinition instance within or across systems.
    Control0..1
    TypeIdentifier
    6. pt-lm-ActivityDefinition.Version
    Definition

    Version identifier for this provider module, used to distinguish different published revisions.

    ShortVersion identifier for this provider module, used to distinguish different published revisions.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesVersie
    8. pt-lm-ActivityDefinition.Name
    Definition

    Name for this activity definition (computer friendly)

    ShortName for this activity definition (computer friendly)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesNaam
    10. pt-lm-ActivityDefinition.Title
    Definition

    Human-friendly title for display and selection.

    ShortHuman-friendly title for display and selection.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesTitel
    12. pt-lm-ActivityDefinition.Status
    Definition

    Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.

    ShortStatus of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesStatus
    14. pt-lm-ActivityDefinition.Publisher
    Definition

    Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.

    ShortOrganization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.
    Control0..1
    Typestring
    Primitive ValueThis 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.

    ShortHuman-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.
    Control0..1
    Typemarkdown
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesOmschrijving
    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.

    ShortGuidance 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.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Alternate NamesGebruik
    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.

    ShortRecommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources.
    Control0..1
    TypeTiming
    Alternate NamesTijdschema

    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.

    ShortActivityDefinition
    Control0..*
    This element is affected by the following invariants: ele-1
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    Alternate NamesModule
    Invariantsele-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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    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.

    ShortAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on pt-lm-ActivityDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. pt-lm-ActivityDefinition.ModuleEndpoint
      Definition

      Endpoint that exposes the launchable activity.

      ShortEndpoint that exposes the launchable activity.
      Control0..1
      TypeReference(Endpoint)
      Alternate NamesEndpoint
      8. pt-lm-ActivityDefinition.Identifier
      Definition

      Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.

      ShortBusiness identifier that uniquely identifies this ActivityDefinition instance within or across systems.
      Control0..1
      TypeIdentifier
      10. pt-lm-ActivityDefinition.Version
      Definition

      Version identifier for this provider module, used to distinguish different published revisions.

      ShortVersion identifier for this provider module, used to distinguish different published revisions.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesVersie
      12. pt-lm-ActivityDefinition.Name
      Definition

      Name for this activity definition (computer friendly)

      ShortName for this activity definition (computer friendly)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesNaam
      14. pt-lm-ActivityDefinition.Title
      Definition

      Human-friendly title for display and selection.

      ShortHuman-friendly title for display and selection.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesTitel
      16. pt-lm-ActivityDefinition.Status
      Definition

      Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.

      ShortStatus of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesStatus
      18. pt-lm-ActivityDefinition.Publisher
      Definition

      Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.

      ShortOrganization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.
      Control0..1
      Typestring
      Primitive ValueThis 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.

      ShortHuman-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.
      Control0..1
      Typemarkdown
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesOmschrijving
      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.

      ShortGuidance 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.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesGebruik
      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.

      ShortRecommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources.
      Control0..1
      TypeTiming
      Alternate NamesTijdschema