eHealth Infrastructure - Local Development build (v2.5.0). See the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition | Version: 2.5.0 | |||
Active as of 2023-02-09 | Computable Name: ehealth-activitydefinition |
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
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 criteriaehealth-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.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 Organizationehealth-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
.A ActivityDefinition has two sets of titles and desriptions. title
and description
are intended for the citizens and should be of a natural language. Whereas ehealth-employee-title
and usage
are intended for clinicians and should be of a specific and professional language.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ActivityDefinition
Path | Conformance | ValueSet |
ActivityDefinition.jurisdiction | required | Jurisdiction |
ActivityDefinition.topic | required | TopicType |
ActivityDefinition.code | required | ActivityDefinitionCode |
Path | Conformance | ValueSet |
ActivityDefinition.status | required | PublicationStatus |
ActivityDefinition.jurisdiction | required | Jurisdiction |
ActivityDefinition.topic | required | TopicType |
ActivityDefinition.code | required | ActivityDefinitionCode |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reuseCriteria | 0..1 | (Complex) | Criteria to be met for reuse of responses to be allowed URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria | |||||
recommendation | 0..1 | CodeableConcept | Recommendation state of the plan definition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation Binding: PlanDefinition Recommendation (required) | |||||
intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |||||
referenceRange | 0..* | (Complex) | Provides guide for interpretation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange | |||||
modifierRole | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |||||
quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |||||
sharingPolicy | 1..1 | CodeableConcept | Policy for sharing a resource with national data banks URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required) | |||||
employeeTitle | 0..1 | string | Title for clinicians URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title | |||||
predecessor | 0..1 | Identifier | Predecessor URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor | |||||
base | 0..1 | Identifier | Base URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base | |||||
baseEnvironment | 0..1 | Identifier | Base environment URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
version | Σ | 1..1 | string | Business version of the activity definition | ||||
name | ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
title | Σ | 0..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. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type 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.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (required) | ||||
purpose | 0..1 | markdown | Why this activity definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the activity definition | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
approvalDate | 0..1 | date | When the activity definition was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the activity definition was last reviewed | |||||
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: Topic Type (required) | |||||
author | 0..* | ContactDetail | Who authored the content | |||||
editor | 0..* | ContactDetail | Who edited the content | |||||
reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
library | 0..* | canonical(ehealth-library) | Logic used by the activity definition | |||||
kind | Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | ||||
intent | 0..1 | code | proposal | 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..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
timing[x] | 0..1 | When activity is to occur | ||||||
timingTiming | Timing | |||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingRange | Range | |||||||
timingDuration | Duration | |||||||
location | 0..1 | Reference(Location) {r} | Where it should happen | |||||
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. | |||||
product[x] | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
productReference | Reference(Medication | Substance) | |||||||
productCodeableConcept | CodeableConcept | |||||||
quantity | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
dosage | 0..* | Dosage | Detailed dosage instructions | |||||
bodySite | 0..* | CodeableConcept | What 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
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 | ||||
path | 1..1 | string | The path to the element to be set dynamically | |||||
expression | 1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ActivityDefinition.language | preferred | CommonLanguages
| ||||
ActivityDefinition.status | required | PublicationStatus | ||||
ActivityDefinition.subject[x] | extensible | SubjectType | ||||
ActivityDefinition.jurisdiction | required | Jurisdiction | ||||
ActivityDefinition.topic | required | TopicType | ||||
ActivityDefinition.kind | required | RequestResourceType | ||||
ActivityDefinition.code | required | ActivityDefinitionCode | ||||
ActivityDefinition.intent | required | RequestIntent | ||||
ActivityDefinition.priority | required | RequestPriority | ||||
ActivityDefinition.participant.type | required | ActionParticipantType | ||||
ActivityDefinition.participant.role | example | ActionParticipantRole | ||||
ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodes | ||||
ActivityDefinition.bodySite | example | SNOMEDCTBodyStructures |
This structure is derived from ActivityDefinition
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ActivityDefinition
Path | Conformance | ValueSet |
ActivityDefinition.jurisdiction | required | Jurisdiction |
ActivityDefinition.topic | required | TopicType |
ActivityDefinition.code | required | ActivityDefinitionCode |
Key Elements View
Path | Conformance | ValueSet |
ActivityDefinition.status | required | PublicationStatus |
ActivityDefinition.jurisdiction | required | Jurisdiction |
ActivityDefinition.topic | required | TopicType |
ActivityDefinition.code | required | ActivityDefinitionCode |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reuseCriteria | 0..1 | (Complex) | Criteria to be met for reuse of responses to be allowed URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-reuseCriteria | |||||
recommendation | 0..1 | CodeableConcept | Recommendation state of the plan definition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation Binding: PlanDefinition Recommendation (required) | |||||
intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |||||
referenceRange | 0..* | (Complex) | Provides guide for interpretation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange | |||||
modifierRole | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |||||
quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |||||
sharingPolicy | 1..1 | CodeableConcept | Policy for sharing a resource with national data banks URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy Binding: Measurement Sharing Policies (required) | |||||
employeeTitle | 0..1 | string | Title for clinicians URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title | |||||
predecessor | 0..1 | Identifier | Predecessor URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor | |||||
base | 0..1 | Identifier | Base URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base | |||||
baseEnvironment | 0..1 | Identifier | Base environment URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
version | Σ | 1..1 | string | Business version of the activity definition | ||||
name | ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
title | Σ | 0..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. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type 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.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group) | |||||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (required) | ||||
purpose | 0..1 | markdown | Why this activity definition is defined | |||||
usage | 0..1 | string | Describes the clinical usage of the activity definition | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
approvalDate | 0..1 | date | When the activity definition was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the activity definition was last reviewed | |||||
effectivePeriod | Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: Topic Type (required) | |||||
author | 0..* | ContactDetail | Who authored the content | |||||
editor | 0..* | ContactDetail | Who edited the content | |||||
reviewer | 0..* | ContactDetail | Who reviewed the content | |||||
endorser | 0..* | ContactDetail | Who endorsed the content | |||||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
library | 0..* | canonical(ehealth-library) | Logic used by the activity definition | |||||
kind | Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | ||||
intent | 0..1 | code | proposal | 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..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
timing[x] | 0..1 | When activity is to occur | ||||||
timingTiming | Timing | |||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingRange | Range | |||||||
timingDuration | Duration | |||||||
location | 0..1 | Reference(Location) {r} | Where it should happen | |||||
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. | |||||
product[x] | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
productReference | Reference(Medication | Substance) | |||||||
productCodeableConcept | CodeableConcept | |||||||
quantity | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
dosage | 0..* | Dosage | Detailed dosage instructions | |||||
bodySite | 0..* | CodeableConcept | What 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
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 | ||||
path | 1..1 | string | The path to the element to be set dynamically | |||||
expression | 1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ActivityDefinition.language | preferred | CommonLanguages
| ||||
ActivityDefinition.status | required | PublicationStatus | ||||
ActivityDefinition.subject[x] | extensible | SubjectType | ||||
ActivityDefinition.jurisdiction | required | Jurisdiction | ||||
ActivityDefinition.topic | required | TopicType | ||||
ActivityDefinition.kind | required | RequestResourceType | ||||
ActivityDefinition.code | required | ActivityDefinitionCode | ||||
ActivityDefinition.intent | required | RequestIntent | ||||
ActivityDefinition.priority | required | RequestPriority | ||||
ActivityDefinition.participant.type | required | ActionParticipantType | ||||
ActivityDefinition.participant.role | example | ActionParticipantRole | ||||
ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodes | ||||
ActivityDefinition.bodySite | example | SNOMEDCTBodyStructures |
This structure is derived from ActivityDefinition
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron