eHealth Infrastructure
2022.1 - release

eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions

Resource Profile: ehealth-activitydefinition

Defining URL:http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition
Version:2022.1
Name:ehealth-activitydefinition
Status:Active as of 1/18/22, 9:57 AM
Publisher:Systematic | Trifork
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://ehealth.sundhed.dk/fhir/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 ServiceRequest 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 ServiceRequest.

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

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

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension 2..*ExtensionExtension
Slice: 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: PlanDefinition Recommendation (required)
... ehealth-referenceRange 0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role 1..*(Complex)Modifier role
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..1CodeableConceptPolicy for sharing a resource with national data banks
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
Binding: Measurement Sharing Policies (required)
... version 1..1stringBusiness version of the activity definition
... jurisdiction 0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction (required)
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the activity definition
... code 1..1CodeableConceptDetail type of activity
Binding: Activity Definition Code (required)
... location 0..1Reference(Location) {r}Where it should happen

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: 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: PlanDefinition Recommendation (required)
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
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)Modifier role
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..1CodeableConceptPolicy for sharing a resource with national data banks
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
Binding: Measurement Sharing Policies (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ1..1stringBusiness version of the activity definition
... name ΣI0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... 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
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: Topic Type (required)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(ehealth-library)Logic used by the activity definition
... kind Σ0..1codeKind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.

... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ1..1CodeableConceptDetail type of activity
Binding: Activity Definition Code (required)
... intent 0..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingAgeAge
.... timingPeriodPeriod
.... timingRangeRange
.... timingDurationDuration
... location 0..1Reference(Location) {r}Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.

.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... 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: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement 0..*Reference(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*Reference(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*Reference(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context

doco Documentation for this format

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension 2..*ExtensionExtension
Slice: 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: PlanDefinition Recommendation (required)
... ehealth-referenceRange 0..*(Complex)Provides guide for interpretation.
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange
... ehealth-modifier-role 1..*(Complex)Modifier role
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..1CodeableConceptPolicy for sharing a resource with national data banks
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
Binding: Measurement Sharing Policies (required)
... version 1..1stringBusiness version of the activity definition
... jurisdiction 0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction (required)
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the activity definition
... code 1..1CodeableConceptDetail type of activity
Binding: Activity Definition Code (required)
... location 0..1Reference(Location) {r}Where it should happen

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: 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: PlanDefinition Recommendation (required)
... ehealth-intendedAudience 0..*Reference()The intended audience of the resource
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)Modifier role
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..1CodeableConceptPolicy for sharing a resource with national data banks
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy
Binding: Measurement Sharing Policies (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ1..1stringBusiness version of the activity definition
... name ΣI0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... 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
... topic 1..1CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: Topic Type (required)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(ehealth-library)Logic used by the activity definition
... kind Σ0..1codeKind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.

... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ1..1CodeableConceptDetail type of activity
Binding: Activity Definition Code (required)
... intent 0..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingAgeAge
.... timingPeriodPeriod
.... timingRangeRange
.... timingDurationDuration
... location 0..1Reference(Location) {r}Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.

.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... 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: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.


... specimenRequirement 0..*Reference(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*Reference(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*Reference(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleSubjectType
ActivityDefinition.jurisdictionrequiredJurisdiction
ActivityDefinition.topicrequiredTopicType
ActivityDefinition.kindrequiredRequestResourceType
ActivityDefinition.coderequiredActivityDefinitionCode
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures