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 |
JSON representation of the pt-lm-ActivityDefinition logical model.
{
"resourceType" : "StructureDefinition",
"id" : "pt-lm-ActivityDefinition",
"text" : {
"status" : "empty",
"div" : "<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>"
},
"url" : "http://medmij.nl/fhir/StructureDefinition/pt-lm-ActivityDefinition",
"version" : "0.1.0",
"name" : "LmActivityDefinition",
"title" : "ActivityDefinition",
"status" : "active",
"date" : "2026-05-08T08:30:17+00:00",
"publisher" : "koppelmij",
"contact" : [
{
"name" : "koppelmij",
"telecom" : [
{
"system" : "url",
"value" : "https://github.com/KoppelMij/"
}
]
}
],
"description" : "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" : "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" : "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" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : true,
"type" : "http://medmij.nl/fhir/StructureDefinition/pt-lm-ActivityDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "4.0.1"
}
],
"element" : [
{
"id" : "pt-lm-ActivityDefinition",
"path" : "pt-lm-ActivityDefinition",
"short" : "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.",
"alias" : [
"Module"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element",
"min" : 0,
"max" : "*"
},
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.id",
"path" : "pt-lm-ActivityDefinition.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.extension",
"path" : "pt-lm-ActivityDefinition.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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.",
"comment" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.ModuleEndpoint",
"path" : "pt-lm-ActivityDefinition.ModuleEndpoint",
"short" : "Endpoint that exposes the launchable activity.",
"definition" : "Endpoint that exposes the launchable activity.",
"alias" : [
"Endpoint"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.ModuleEndpoint",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Identifier",
"path" : "pt-lm-ActivityDefinition.Identifier",
"short" : "Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.",
"definition" : "Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Version",
"path" : "pt-lm-ActivityDefinition.Version",
"short" : "Version identifier for this provider module, used to distinguish different published revisions.",
"definition" : "Version identifier for this provider module, used to distinguish different published revisions.",
"alias" : [
"Versie"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Name",
"path" : "pt-lm-ActivityDefinition.Name",
"short" : "Name for this activity definition (computer friendly)",
"definition" : "Name for this activity definition (computer friendly)",
"alias" : [
"Naam"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Title",
"path" : "pt-lm-ActivityDefinition.Title",
"short" : "Human-friendly title for display and selection.",
"definition" : "Human-friendly title for display and selection.",
"alias" : [
"Titel"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Status",
"path" : "pt-lm-ActivityDefinition.Status",
"short" : "Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.",
"definition" : "Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.",
"alias" : [
"Status"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Publisher",
"path" : "pt-lm-ActivityDefinition.Publisher",
"short" : "Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.",
"definition" : "Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Publisher",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Description",
"path" : "pt-lm-ActivityDefinition.Description",
"short" : "Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.",
"definition" : "Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.",
"alias" : [
"Omschrijving"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "markdown"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Usage",
"path" : "pt-lm-ActivityDefinition.Usage",
"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.",
"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.",
"alias" : [
"Gebruik"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Usage",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Timing",
"path" : "pt-lm-ActivityDefinition.Timing",
"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.",
"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.",
"alias" : [
"Tijdschema"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "pt-lm-ActivityDefinition.Timing",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Timing"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "pt-lm-ActivityDefinition",
"path" : "pt-lm-ActivityDefinition",
"short" : "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.",
"alias" : [
"Module"
]
},
{
"id" : "pt-lm-ActivityDefinition.ModuleEndpoint",
"path" : "pt-lm-ActivityDefinition.ModuleEndpoint",
"short" : "Endpoint that exposes the launchable activity.",
"definition" : "Endpoint that exposes the launchable activity.",
"alias" : [
"Endpoint"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Identifier",
"path" : "pt-lm-ActivityDefinition.Identifier",
"short" : "Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.",
"definition" : "Business identifier that uniquely identifies this ActivityDefinition instance within or across systems.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Version",
"path" : "pt-lm-ActivityDefinition.Version",
"short" : "Version identifier for this provider module, used to distinguish different published revisions.",
"definition" : "Version identifier for this provider module, used to distinguish different published revisions.",
"alias" : [
"Versie"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Name",
"path" : "pt-lm-ActivityDefinition.Name",
"short" : "Name for this activity definition (computer friendly)",
"definition" : "Name for this activity definition (computer friendly)",
"alias" : [
"Naam"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Title",
"path" : "pt-lm-ActivityDefinition.Title",
"short" : "Human-friendly title for display and selection.",
"definition" : "Human-friendly title for display and selection.",
"alias" : [
"Titel"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Status",
"path" : "pt-lm-ActivityDefinition.Status",
"short" : "Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.",
"definition" : "Status of the provider module (for example draft, active, retired). Indicates whether it may be used in workflows.",
"alias" : [
"Status"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Publisher",
"path" : "pt-lm-ActivityDefinition.Publisher",
"short" : "Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.",
"definition" : "Organization responsible for publishing this activity definition. The publisher owns the content and/or functionality and manages versioning.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Description",
"path" : "pt-lm-ActivityDefinition.Description",
"short" : "Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.",
"definition" : "Human-readable explanation of what the activity is and how it supports the care process. This description is reusable and not patient-specific.",
"alias" : [
"Omschrijving"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "markdown"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Usage",
"path" : "pt-lm-ActivityDefinition.Usage",
"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.",
"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.",
"alias" : [
"Gebruik"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "pt-lm-ActivityDefinition.Timing",
"path" : "pt-lm-ActivityDefinition.Timing",
"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.",
"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.",
"alias" : [
"Tijdschema"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Timing"
}
]
}
]
}
}