Koppeltaal 2.0 Implementation Guide (Full Documentation)
1.4.5-beta.002 - ci-build Netherlands flag

Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v1.4.5-beta.002) 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: 1.4.5-beta.002
Draft as of 2023-01-24 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: 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..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.
... 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

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
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()

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition Description of an eHealth activity
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..* 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
... useContext 0..0
... 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.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: 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..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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
... 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
.... 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

PathConformanceValueSetURI
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.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()

This structure is derived from ActivityDefinition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition C 0..* ActivityDefinition Description of an eHealth activity
Constraints: 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..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.
... 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

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
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()

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ActivityDefinition 0..* ActivityDefinition Description of an eHealth activity
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..* 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
... useContext 0..0
... 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.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: 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..* 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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
... 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
.... 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

PathConformanceValueSetURI
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.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()

This structure is derived from ActivityDefinition

 

Other representations of profile: CSV, Excel, Schematron