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 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.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
.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 May 22 12:11:22 UTC 2020 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
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from ActivityDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context. | |
extension | 0..* | Extension | Extension 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..1 | CodeableConcept | Recommendation 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 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..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy | |
version | 1..1 | string | Business version of the activity definition | |
jurisdiction | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (extensible) | |
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Topic Type (required) | |
relatedArtifact | 0..* | RelatedArtifact | Related artifacts for a knowledge resource | |
library | 0..* | Reference(eHealth Library) {r} | Logic used by the asset | |
code | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | |
location | 0..1 | Reference(Location) {r} | Where it should happen | |
product[x] | 0..1 | What's administered/supplied | ||
productReference | Reference(Medication | Substance) | |||
productCodeableConcept | CodeableConcept | |||
transform | 0..1 | Reference(StructureMap) {r} | Transform to apply the template | |
Documentation for this format |
This structure is derived from ActivityDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | I | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-reuseCriteria | I | 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 | I | 0..1 | CodeableConcept | Recommendation state of the plan definition. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation |
ehealth-intendedAudience | I | 0..* | Reference() | The intended audience of the activitydefinition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience |
ehealth-referenceRange | I | 0..* | (Complex) | Provides guide for interpretation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange |
ehealth-modifier-role | I | 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 | I | 0..* | (Complex) | Minimum requirements for qualities. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality |
ehealth-sharingPolicy | I | 1..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this activity definition (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition |
version | Σ | 1..1 | string | Business version of the activity definition |
name | Σ | 0..1 | string | Name for this activity definition (computer friendly) |
title | Σ | 0..1 | string | Name for this activity definition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the activity definition |
purpose | 0..1 | markdown | Why this activity definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the asset | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (extensible) |
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Topic Type (required) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | I | 0..* | RelatedArtifact | Related artifacts for a knowledge resource |
library | 0..* | Reference(eHealth Library) {r} | Logic used by the asset | |
kind | 0..1 | code | Kind of resource Binding: ResourceType (required) | |
code | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | |
timing[x] | 0..1 | When activity is to occur | ||
timingTiming | Timing | |||
timingDateTime | dateTime | |||
timingPeriod | Period | |||
timingRange | Range | |||
location | 0..1 | Reference(Location) {r} | Where it should happen | |
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | 1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required) | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example) | |
product[x] | 0..1 | What's administered/supplied Binding: SNOMED CT Medication Codes (example) | ||
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: SNOMED CT Body Structures (example) | |
transform | 0..1 | Reference(StructureMap) {r} | Transform to apply the template | |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Natural language description of the dynamic value | |
path | 0..1 | string | The path to the element to be set dynamically | |
language | 0..1 | string | Language of the expression | |
expression | 0..1 | string | An expression that provides the dynamic value for the customization | |
Documentation for this format |
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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | 0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context. | |
extension | 0..* | Extension | Extension 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..1 | CodeableConcept | Recommendation 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 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..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy | |
version | 1..1 | string | Business version of the activity definition | |
jurisdiction | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (extensible) | |
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Topic Type (required) | |
relatedArtifact | 0..* | RelatedArtifact | Related artifacts for a knowledge resource | |
library | 0..* | Reference(eHealth Library) {r} | Logic used by the asset | |
code | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | |
location | 0..1 | Reference(Location) {r} | Where it should happen | |
product[x] | 0..1 | What's administered/supplied | ||
productReference | Reference(Medication | Substance) | |||
productCodeableConcept | CodeableConcept | |||
transform | 0..1 | Reference(StructureMap) {r} | Transform to apply the template | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | I | 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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-reuseCriteria | I | 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 | I | 0..1 | CodeableConcept | Recommendation state of the plan definition. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation |
ehealth-intendedAudience | I | 0..* | Reference() | The intended audience of the activitydefinition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience |
ehealth-referenceRange | I | 0..* | (Complex) | Provides guide for interpretation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange |
ehealth-modifier-role | I | 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 | I | 0..* | (Complex) | Minimum requirements for qualities. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality |
ehealth-sharingPolicy | I | 1..1 | CodeableConcept | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this activity definition (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition |
version | Σ | 1..1 | string | Business version of the activity definition |
name | Σ | 0..1 | string | Name for this activity definition (computer friendly) |
title | Σ | 0..1 | string | Name for this activity definition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the activity definition |
purpose | 0..1 | markdown | Why this activity definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the asset | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction (extensible) |
topic | 1..1 | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Topic Type (required) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | I | 0..* | RelatedArtifact | Related artifacts for a knowledge resource |
library | 0..* | Reference(eHealth Library) {r} | Logic used by the asset | |
kind | 0..1 | code | Kind of resource Binding: ResourceType (required) | |
code | 1..1 | CodeableConcept | Detail type of activity Binding: Activity Definition Code (required) | |
timing[x] | 0..1 | When activity is to occur | ||
timingTiming | Timing | |||
timingDateTime | dateTime | |||
timingPeriod | Period | |||
timingRange | Range | |||
location | 0..1 | Reference(Location) {r} | Where it should happen | |
participant | I | 0..* | BackboneElement | Who should participate in the action |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | 1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required) | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example) | |
product[x] | 0..1 | What's administered/supplied Binding: SNOMED CT Medication Codes (example) | ||
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: SNOMED CT Body Structures (example) | |
transform | 0..1 | Reference(StructureMap) {r} | Transform to apply the template | |
dynamicValue | I | 0..* | BackboneElement | Dynamic aspects of the definition |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
description | 0..1 | string | Natural language description of the dynamic value | |
path | 0..1 | string | The path to the element to be set dynamically | |
language | 0..1 | string | Language of the expression | |
expression | 0..1 | string | An expression that provides the dynamic value for the customization | |
Documentation for this format |
Path | Conformance | ValueSet |
ActivityDefinition.language | extensible | Common Languages Max Binding: All Languages |
ActivityDefinition.status | required | PublicationStatus |
ActivityDefinition.jurisdiction | extensible | Jurisdiction |
ActivityDefinition.topic | required | TopicType |
ActivityDefinition.kind | required | ResourceType |
ActivityDefinition.code | required | ActivityDefinitionCode |
ActivityDefinition.participant.type | required | ActionParticipantType |
ActivityDefinition.participant.role | example | ActionParticipantRole |
ActivityDefinition.product[x] | example | SNOMED CT Medication Codes |
ActivityDefinition.bodySite | example | SNOMED CT Body Structures |
Id | Path | Details | Requirements |
dom-2 | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | ActivityDefinition | If 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-3 | ActivityDefinition | If 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-1 | ActivityDefinition.extension:reuseCriteria | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:reuseCriteria | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:recommendation | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:recommendation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:intendedAudience | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:intendedAudience | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:referenceRange | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:referenceRange | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:modifierRole | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:modifierRole | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:minimumQuality | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:minimumQuality | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.extension:sharingPolicy | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | ActivityDefinition.extension:sharingPolicy | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | ActivityDefinition.relatedArtifact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ActivityDefinition.participant | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | ActivityDefinition.dynamicValue | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |