eHealth Infrastructure (v2019.6)

StructureDefinition: ehealth-activitydefinition

Introduction

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

Scope and Usage

In the eHealth Infrastructure the ActivityDefinition resource is used together with PlanDefinition to define the steps to be performed in the course of a telemedical package. As the name implies, the ActivityDefinition resource is strictly definitional. It does not represent the intention to take any action, nor does it represent that any actions have been taken. Rather, the resource provides a definition that can be applied in the appropriate circumstances.

Once a PlanDefinition is applied to a Patient it is transformed into a CarePlan, and all of the PlanDefinition’s underlying ActivityDefinitions are transformed into activities under the CarePlan.

The eHealth profile of ActivityDefinition has the following extensions:

  • ehealth-reuseCriteria which defines whether resource(s) resulting from conducting the activity may be reused and if so with which criteria
  • ehealth-recommendation which defines the recommendation level of this ActivityDefinition. The values of the used ValueSet allows for indicating the life cycle state, for instance that it is a draft or recommended ActivityDefinition.
  • ehealth-intendedAudience can be set to one or more Organizations to indicate for which Organization(s) this ActivityDefinition should be selectable for use. This is meant for filtering and is not enforced or in any way restricting which Organization have access.
  • ehealth-referenceRange can contain one or more reference ranges against which values in measurements (resource(s) resulting from conducting the activity) can be compared. The reference ranges in the ActivityDefinition function as templates assigned and adaptable to a particular Patient in the ProcedureRequest reference ranges.
  • ehealth-modifier-role see below.
  • ehealth-quality The minimum quality levels that should be obtained with measurements (resource(s) resulting from conducting the activity). These do not constitute enforced levels but rather expectations which may or may not be met with actual submitted measurements.
  • ehealth-sharingPolicy sets a stance on whether publication to national document sharing of the measurements (resource(s) resulting from conducting the activity) shall be allowed or not. The value in the ActivityDefinition function as a template assigned and adaptable to a particular Patient in a similar element in the ProcedureRequest.

Update restrictions

The element ehealth-modifier-role specifies one or more Organization and each Organization’s role in maintaining the ActivityDefinition:

  • ehealth-modifier-role.reference references the Organization
  • ehealth-modifier-role.role set to owner means that the referenced Organization can update the resource and alter the entities referenced by ehealth-modifier-role, for instance, by adding more co-authors.
  • ehealth-modifier-role.role set to co-author means that the referenced Organization can update the resource but not alter the element ehealth-modifier-role.

Formal Views of Profile Content

The official URL for this profile is: 

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition

This profile builds on ActivityDefinition.

This profile was published on Fri Nov 08 13:01:00 UTC 2019 as a draft by ehealth.sundhed.dk.

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

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*The definition of a specific activity to be taken, independent of any particular patient or context.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-reuseCriteria 0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... ehealth-recommendation 0..1CodeableConceptRecommendation state of the plan definition.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinitionRecommendation (required)
... ehealth-intendedAudience 0..*Reference()The intended audience of the activitydefinition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-referenceRange 0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role 1..*(Complex)Maintainers of the activity definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... ehealth-quality 0..*(Complex)Minimum requirements for qualities.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... ehealth-sharingPolicy 1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... version 1..1string
... topic 1..1CodeableConceptBinding: TopicType (required)
... relatedArtifact 0..*RelatedArtifact
... library 0..*Reference(eHealth Library) {r}
... code 1..1CodeableConceptBinding: ActivityDefinitionCode (required)
... location 0..1Reference(Location) {r}
... product[x] 0..1
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... transform 0..1Reference(StructureMap) {r}

doco Documentation for this format

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*The definition of a specific activity to be taken, independent of any particular patient or context.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-reuseCriteria I0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... ehealth-recommendation I0..1CodeableConceptRecommendation state of the plan definition.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
... ehealth-intendedAudience I0..*Reference()The intended audience of the activitydefinition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-referenceRange I0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role I1..*(Complex)Maintainers of the activity definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... ehealth-quality I0..*(Complex)Minimum requirements for qualities.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... ehealth-sharingPolicy I1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this activity definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ1..1stringBusiness version of the activity definition
... name Σ0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the activity definition
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: TopicType (required)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact I0..*RelatedArtifactRelated artifacts for a knowledge resource
... library 0..*Reference(eHealth Library) {r}Logic used by the asset
... kind 0..1codeKind of resource
Binding: ResourceType (required)
... code 1..1CodeableConceptDetail type of activity
Binding: ActivityDefinitionCode (required)
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingPeriodPeriod
.... timingRangeRange
... location 0..1Reference(Location) {r}Where it should happen
... participant I0..*BackboneElementWho should participate in the action
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1codepatient | practitioner | related-person
Binding: ActionParticipantType (required)
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMED CT Medication Codes (example)
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMED CT Body Structures (example)
... transform 0..1Reference(StructureMap) {r}Transform to apply the template
... dynamicValue I0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringNatural language description of the dynamic value
.... path 0..1stringThe path to the element to be set dynamically
.... language 0..1stringLanguage of the expression
.... expression 0..1stringAn expression that provides the dynamic value for the customization

doco Documentation for this format

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*The definition of a specific activity to be taken, independent of any particular patient or context.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-reuseCriteria 0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... ehealth-recommendation 0..1CodeableConceptRecommendation state of the plan definition.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinitionRecommendation (required)
... ehealth-intendedAudience 0..*Reference()The intended audience of the activitydefinition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-referenceRange 0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role 1..*(Complex)Maintainers of the activity definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... ehealth-quality 0..*(Complex)Minimum requirements for qualities.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... ehealth-sharingPolicy 1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... version 1..1string
... topic 1..1CodeableConceptBinding: TopicType (required)
... relatedArtifact 0..*RelatedArtifact
... library 0..*Reference(eHealth Library) {r}
... code 1..1CodeableConceptBinding: ActivityDefinitionCode (required)
... location 0..1Reference(Location) {r}
... product[x] 0..1
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... transform 0..1Reference(StructureMap) {r}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*The definition of a specific activity to be taken, independent of any particular patient or context.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-reuseCriteria I0..1(Complex)Criteria to be met for reuse of responses to be allowed.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria
... ehealth-recommendation I0..1CodeableConceptRecommendation state of the plan definition.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
... ehealth-intendedAudience I0..*Reference()The intended audience of the activitydefinition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... ehealth-referenceRange I0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role I1..*(Complex)Maintainers of the activity definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... ehealth-quality I0..*(Complex)Minimum requirements for qualities.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... ehealth-sharingPolicy I1..1CodeableConceptExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this activity definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ1..1stringBusiness version of the activity definition
... name Σ0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description Σ0..1markdownNatural language description of the activity definition
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: TopicType (required)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact I0..*RelatedArtifactRelated artifacts for a knowledge resource
... library 0..*Reference(eHealth Library) {r}Logic used by the asset
... kind 0..1codeKind of resource
Binding: ResourceType (required)
... code 1..1CodeableConceptDetail type of activity
Binding: ActivityDefinitionCode (required)
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingPeriodPeriod
.... timingRangeRange
... location 0..1Reference(Location) {r}Where it should happen
... participant I0..*BackboneElementWho should participate in the action
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1codepatient | practitioner | related-person
Binding: ActionParticipantType (required)
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMED CT Medication Codes (example)
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMED CT Body Structures (example)
... transform 0..1Reference(StructureMap) {r}Transform to apply the template
... dynamicValue I0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 0..1stringNatural language description of the dynamic value
.... path 0..1stringThe path to the element to be set dynamically
.... language 0..1stringLanguage of the expression
.... expression 0..1stringAn expression that provides the dynamic value for the customization

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.languageextensibleCommon Languages
Max Binding: All Languages
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
ActivityDefinition.topicrequiredTopicType
ActivityDefinition.kindrequiredResourceType
ActivityDefinition.coderequiredActivityDefinitionCode
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.product[x]exampleSNOMED CT Medication Codes
ActivityDefinition.bodySiteexampleSNOMED CT Body Structures

Constraints

IdPathDetailsRequirements
dom-2ActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ActivityDefinitionIf 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-3ActivityDefinitionIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1ActivityDefinition.participantAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1ActivityDefinition.dynamicValueAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.