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 |
XML representation of the pt-lm-ActivityDefinition logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="pt-lm-ActivityDefinition"/>
<text>
<status value="empty"/>
<div xmlns="http://www.w3.org/1999/xhtml">No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.</div>
</text>
<url
value="http://medmij.nl/fhir/StructureDefinition/pt-lm-ActivityDefinition"/>
<version value="0.1.0"/>
<name value="LmActivityDefinition"/>
<title value="ActivityDefinition"/>
<status value="active"/>
<date value="2026-05-08T08:30:17+00:00"/>
<publisher value="koppelmij"/>
<contact>
<name value="koppelmij"/>
<telecom>
<system value="url"/>
<value value="https://github.com/KoppelMij/"/>
</telecom>
</contact>
<description
value="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."/>
<purpose
value="To describe a launchable digital (eHealth) activity as a reusable template, including clinical intent and the information needed to invoke the activity in the correct context. Patient-specific workflow management and status tracking are handled in separate Task resources that reference this definition."/>
<copyright
value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise."/>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="true"/>
<type
value="http://medmij.nl/fhir/StructureDefinition/pt-lm-ActivityDefinition"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="4.0.1"/>
</extension>
<element id="pt-lm-ActivityDefinition">
<path value="pt-lm-ActivityDefinition"/>
<short value="ActivityDefinition"/>
<definition
value="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."/>
<alias value="Module"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element"/>
<min value="0"/>
<max value="*"/>
</base>
<condition value="ele-1"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="pt-lm-ActivityDefinition.id">
<path value="pt-lm-ActivityDefinition.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="pt-lm-ActivityDefinition.extension">
<path value="pt-lm-ActivityDefinition.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="pt-lm-ActivityDefinition.ModuleEndpoint">
<path value="pt-lm-ActivityDefinition.ModuleEndpoint"/>
<short value="Endpoint that exposes the launchable activity."/>
<definition value="Endpoint that exposes the launchable activity."/>
<alias value="Endpoint"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.ModuleEndpoint"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Endpoint"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Identifier">
<path value="pt-lm-ActivityDefinition.Identifier"/>
<short
value="Business identifier that uniquely identifies this ActivityDefinition instance within or across systems."/>
<definition
value="Business identifier that uniquely identifies this ActivityDefinition instance within or across systems."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Identifier"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Identifier"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Version">
<path value="pt-lm-ActivityDefinition.Version"/>
<short
value="Version identifier for this provider module, used to distinguish different published revisions."/>
<definition
value="Version identifier for this provider module, used to distinguish different published revisions."/>
<alias value="Versie"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Version"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Name">
<path value="pt-lm-ActivityDefinition.Name"/>
<short value="Name for this activity definition (computer friendly)"/>
<definition
value="Name for this activity definition (computer friendly)"/>
<alias value="Naam"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Name"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Title">
<path value="pt-lm-ActivityDefinition.Title"/>
<short value="Human-friendly title for display and selection."/>
<definition value="Human-friendly title for display and selection."/>
<alias value="Titel"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Title"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Status">
<path value="pt-lm-ActivityDefinition.Status"/>
<short
value="Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows."/>
<definition
value="Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows."/>
<alias value="Status"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Status"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Publisher">
<path value="pt-lm-ActivityDefinition.Publisher"/>
<short
value="Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning."/>
<definition
value="Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Publisher"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Description">
<path value="pt-lm-ActivityDefinition.Description"/>
<short
value="Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific."/>
<definition
value="Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific."/>
<alias value="Omschrijving"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Description"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Usage">
<path value="pt-lm-ActivityDefinition.Usage"/>
<short
value="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."/>
<definition
value="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."/>
<alias value="Gebruik"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Usage"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Timing">
<path value="pt-lm-ActivityDefinition.Timing"/>
<short
value="Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources."/>
<definition
value="Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources."/>
<alias value="Tijdschema"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="pt-lm-ActivityDefinition.Timing"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Timing"/>
</type>
</element>
</snapshot>
<differential>
<element id="pt-lm-ActivityDefinition">
<path value="pt-lm-ActivityDefinition"/>
<short value="ActivityDefinition"/>
<definition
value="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."/>
<alias value="Module"/>
</element>
<element id="pt-lm-ActivityDefinition.ModuleEndpoint">
<path value="pt-lm-ActivityDefinition.ModuleEndpoint"/>
<short value="Endpoint that exposes the launchable activity."/>
<definition value="Endpoint that exposes the launchable activity."/>
<alias value="Endpoint"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Endpoint"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Identifier">
<path value="pt-lm-ActivityDefinition.Identifier"/>
<short
value="Business identifier that uniquely identifies this ActivityDefinition instance within or across systems."/>
<definition
value="Business identifier that uniquely identifies this ActivityDefinition instance within or across systems."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Identifier"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Version">
<path value="pt-lm-ActivityDefinition.Version"/>
<short
value="Version identifier for this provider module, used to distinguish different published revisions."/>
<definition
value="Version identifier for this provider module, used to distinguish different published revisions."/>
<alias value="Versie"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Name">
<path value="pt-lm-ActivityDefinition.Name"/>
<short value="Name for this activity definition (computer friendly)"/>
<definition
value="Name for this activity definition (computer friendly)"/>
<alias value="Naam"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Title">
<path value="pt-lm-ActivityDefinition.Title"/>
<short value="Human-friendly title for display and selection."/>
<definition value="Human-friendly title for display and selection."/>
<alias value="Titel"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Status">
<path value="pt-lm-ActivityDefinition.Status"/>
<short
value="Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows."/>
<definition
value="Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows."/>
<alias value="Status"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Publisher">
<path value="pt-lm-ActivityDefinition.Publisher"/>
<short
value="Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning."/>
<definition
value="Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Description">
<path value="pt-lm-ActivityDefinition.Description"/>
<short
value="Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific."/>
<definition
value="Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific."/>
<alias value="Omschrijving"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="markdown"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Usage">
<path value="pt-lm-ActivityDefinition.Usage"/>
<short
value="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."/>
<definition
value="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."/>
<alias value="Gebruik"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="pt-lm-ActivityDefinition.Timing">
<path value="pt-lm-ActivityDefinition.Timing"/>
<short
value="Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources."/>
<definition
value="Recommended timing for the activity when applied in a workflow (e.g., once, recurring, over a period). Patient-specific scheduling belongs in ServiceRequest resources."/>
<alias value="Tijdschema"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Timing"/>
</type>
</element>
</differential>
</StructureDefinition>