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

Resource Profile: KT2_ActivityDefinition

Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2ActivityDefinition Version: 0.15.0
Draft as of 2025-10-07 Realm: Netherlands flag Computable Name: KT2_ActivityDefinition

Copyright/Legal: VZVZ

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition Description of an eHealth activity
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..1 id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... title Σ 1..1 string Name for this activity definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
..... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
.... useContext:koppeltaal-expansion Σ 0..* UsageContext Optional expansion for the activity
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.coderequiredPattern Value: koppeltaal-expansion
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
exp-1errorActivityDefinition.dynamicValue.expressionAn expression or a reference must be provided
: expression.exists() or reference.exists()

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition Description of an eHealth activity
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..* id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... url 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... title 1..1 string Name for this activity definition (human friendly)
... experimental 0..0
... subject[x] 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... Slices for useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... code 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
.... useContext:koppeltaal-expansion 0..* UsageContext Optional expansion for the activity
..... code 1..1 Coding Usage context type including Koppeltaal extensions
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
..... Slices for value[x] 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... jurisdiction 0..0
... purpose 0..0
... usage 0..0
... copyright 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... library 0..0
... kind 0..0
... profile 0..0
... intent 0..0
... priority 0..0
... doNotPerform 0..0
... timing[x] 0..0
... location 0..0
... product[x] 0..0
... quantity 0..0
... dosage 0..0
... bodySite 0..0
... specimenRequirement 0..0
... observationRequirement 0..0
... observationResultRequirement 0..0
... transform 0..0
... dynamicValue 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition Description of an eHealth activity
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..1 id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... url Σ 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... version Σ 0..1 string Business version of the activity definition
... name ΣC 0..1 string Name for this activity definition (computer friendly)
... title Σ 1..1 string Name for this activity definition (human friendly)
... subtitle 0..1 string Subordinate title of the activity definition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 0..1 markdown Natural language description of the activity definition
... Slices for useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
..... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
.... useContext:koppeltaal-expansion Σ 0..* UsageContext Optional expansion for the activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities
... code Σ 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
... participant 0..* BackboneElement Who should participate in the action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.coderequiredPattern Value: koppeltaal-expansion
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
exp-1errorActivityDefinition.dynamicValue.expressionAn expression or a reference must be provided
: expression.exists() or reference.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 34 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.useContext
  • The element 1 is sliced based on the value of ActivityDefinition.useContext.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition Description of an eHealth activity
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..1 id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... title Σ 1..1 string Name for this activity definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
..... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
.... useContext:koppeltaal-expansion Σ 0..* UsageContext Optional expansion for the activity
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.coderequiredPattern Value: koppeltaal-expansion
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
exp-1errorActivityDefinition.dynamicValue.expressionAn expression or a reference must be provided
: expression.exists() or reference.exists()

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition Description of an eHealth activity
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..* id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... url 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... title 1..1 string Name for this activity definition (human friendly)
... experimental 0..0
... subject[x] 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... Slices for useContext 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... code 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
.... useContext:koppeltaal-expansion 0..* UsageContext Optional expansion for the activity
..... code 1..1 Coding Usage context type including Koppeltaal extensions
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
..... Slices for value[x] 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... jurisdiction 0..0
... purpose 0..0
... usage 0..0
... copyright 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... library 0..0
... kind 0..0
... profile 0..0
... intent 0..0
... priority 0..0
... doNotPerform 0..0
... timing[x] 0..0
... location 0..0
... product[x] 0..0
... quantity 0..0
... dosage 0..0
... bodySite 0..0
... specimenRequirement 0..0
... observationRequirement 0..0
... observationResultRequirement 0..0
... transform 0..0
... dynamicValue 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition Description of an eHealth activity
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, adf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
.... extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint to the service application
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension
.... extension:publisherId 0..1 id Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... url Σ 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the activity definition
... version Σ 0..1 string Business version of the activity definition
... name ΣC 0..1 string Name for this activity definition (computer friendly)
... title Σ 1..1 string Name for this activity definition (human friendly)
... subtitle 0..1 string Subordinate title of the activity definition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 0..1 markdown Natural language description of the activity definition
... Slices for useContext Σ 0..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by pattern:code
.... useContext:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
..... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
.... useContext:koppeltaal-expansion Σ 0..* UsageContext Optional expansion for the activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ 1..1 Coding Usage context type including Koppeltaal extensions
Binding: Koppeltaal Usage Context Type (required): Standard usage context types extended with Koppeltaal specific context types
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: koppeltaal-expansion
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... Slices for value[x] Σ 1..1 CodeableConcept Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.
...... value[x]:valueCodeableConcept Σ 1..1 CodeableConcept The specific expansion
Binding: Koppeltaal Expansion (required): Optional expansions for Koppeltaal activities
... topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc.
Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities
... code Σ 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
... participant 0..* BackboneElement Who should participate in the action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
.... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ActivityDefinition.useContext.coderequiredKoppeltaalUsageContextType_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.coderequiredPattern Value: koppeltaal-expansion
http://vzvz.nl/fhir/ValueSet/koppeltaal-use-context-type
From this IG
ActivityDefinition.useContext:koppeltaal-expansion.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
From the FHIR Standard
ActivityDefinition.useContext:koppeltaal-expansion.value[x]:valueCodeableConceptrequiredKoppeltaalExpansion_VS(a valid code from Koppeltaal Expansion)
http://vzvz.nl/fhir/ValueSet/koppeltaal-expansion
From this IG
ActivityDefinition.topicextensibleKoppeltaalDefinitionTopic_VS
http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic
From this IG
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
From the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
exp-1errorActivityDefinition.dynamicValue.expressionAn expression or a reference must be provided
: expression.exists() or reference.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 34 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.useContext
  • The element 1 is sliced based on the value of ActivityDefinition.useContext.value[x]

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Required Extensions

Endpoint Extension

The extension[endpoint] is mandatory and contains one or more references to the service application (endpoint) that provides the eHealth activity. This ensures that the activity definition is properly linked to the system(s) that can execute it.

Example:

{
  "extension": [{
    "url": "http://koppeltaal.nl/fhir/StructureDefinition/KT2-Endpoint",
    "valueReference": {
      "reference": "Endpoint/example-endpoint"
    }
  }]
}
PublisherId Extension

The extension[publisherId] is optional and can be used to identify the publisher of the activity definition.

Topic

The topic element uses the KoppeltaalDefinitionTopic ValueSet to categorize the activity. This is particularly important for indicating patient-initiated activities.

Common topics include:

  • Self-Treatment
  • Self-Assessment
  • Education
  • Exercise
  • Monitoring

Example:

{
  "topic": [{
    "coding": [{
      "system": "http://koppeltaal.nl/CodeSystem/definition-topic",
      "code": "self-treatment"
    }]
  }]
}

URL

The url element is required and should contain a unique identifier for the activity definition. This URL should be stable and globally unique.

Title

The title element is required and should provide a human-readable name for the activity that can be displayed in user interfaces.