---
type: "resource-definitions"
title: "ActivityDefinition Definitions"
resource: "ActivityDefinition"
---

# ActivityDefinition Definitions

<a id="ActivityDefinition"></a>

## ActivityDefinition
The definition of a specific activity to be taken, independent of any particular patient or context

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

**Cardinality:** 0..*

**Constraints:** cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')

**Mappings:** workflow=Definition; rim=Act[classCode=ACT; moodCode=DEFN]; w5=clinical.general


<a id="ActivityDefinition.url"></a>

## ActivityDefinition.url
Canonical identifier for this activity definition, represented as a URI (globally unique)

**Definition:** An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.

**Comments:** Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred.  Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author.  Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). 

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.

**Requirements:** Allows the activity definition to be referenced by a single globally unique identifier.

**Cardinality:** 0..1

**Type:** [uri](/uri)

**Summary:** true

**Constraints:** cnl-1 | warning | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$')

**Mappings:** workflow=Definition.url; w5=FiveWs.identifier; rim=.identifier[scope=BUSN;reliability=ISS]


<a id="ActivityDefinition.identifier"></a>

## ActivityDefinition.identifier
Additional identifier for the activity definition

**Definition:** A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

**Requirements:** Allows externally provided and/or usable business identifiers to be easily associated with the module.

**Cardinality:** 0..*

**Type:** [Identifier](/Identifier)

**Summary:** true

**Mappings:** workflow=Definition.identifier; w5=FiveWs.identifier; rim=.identifier; objimpl=no-gen-base


<a id="ActivityDefinition.version"></a>

## ActivityDefinition.version
Business version of the activity definition

**Definition:** The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

**Comments:** There may be different activity definition instances that have the same identifier but different versions.  The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** workflow=Definition.version; w5=FiveWs.version; rim=N/A (to add?)


<a id="ActivityDefinition.versionAlgorithm[x]"></a>

## ActivityDefinition.versionAlgorithm[x]
How to compare versions

**Definition:** Indicates the mechanism used to compare versions to determine which is more current.

**Comments:** If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

**Cardinality:** 0..1

**Type:** [string](/string), [Coding](/Coding)

**Binding:** extensible:[version-algorithm](/valueset-version-algorithm)

**Summary:** true

**Mappings:** workflow=Definition.versionAlgorithm; w5=FiveWs.version; rim=N/A (to add?)


<a id="ActivityDefinition.name"></a>

## ActivityDefinition.name
Name for this activity definition (computer friendly)

**Definition:** A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

**Comments:** The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

**Requirements:** Support human navigation and code generation.

**Conditions:** cnl-0

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** workflow=Definition.name; rim=N/A


<a id="ActivityDefinition.title"></a>

## ActivityDefinition.title
Name for this activity definition (human friendly)

**Definition:** A short, descriptive, user-friendly title for the activity definition.

**Comments:** This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** workflow=Definition.title; rim=.title


<a id="ActivityDefinition.subtitle"></a>

## ActivityDefinition.subtitle
Subordinate title of the activity definition

**Definition:** An explanatory or alternate title for the activity definition giving additional information about its content.

**Cardinality:** 0..1

**Type:** [string](/string)

**Mappings:** rim=N/A (to add?)


<a id="ActivityDefinition.status"></a>

## ActivityDefinition.status
draft | active | retired | unknown

**Definition:** The status of this activity definition. Enables tracking the life-cycle of the content.

**Comments:** Allows filtering of activity definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 1..1

**Type:** [code](/code)

**Binding:** required:[publication-status](/valueset-publication-status)

**Summary:** true

**Is Modifier:** true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

**Mappings:** workflow=Definition.status {different ValueSet}; w5=FiveWs.status; rim=.status


<a id="ActivityDefinition.experimental"></a>

## ActivityDefinition.experimental
For testing only - never for real usage

**Definition:** A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

**Comments:** Allows filtering of activity definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource.  (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

**Requirements:** Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.

**Meaning if Missing:** If absent, this resource is treated as though it is not experimental.

**Cardinality:** 0..1

**Type:** [boolean](/boolean)

**Summary:** true

**Mappings:** workflow=Definition.experimental; w5=FiveWs.class; rim=N/A (to add?)


<a id="ActivityDefinition.subject[x]"></a>

## ActivityDefinition.subject[x]
Type of individual the activity definition is intended for

**Definition:** A code, group definition, or canonical reference that describes  or identifies the intended subject of the activity being defined.  Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

**Comments:** Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

**Meaning if Missing:** Patient

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept), Reference([Group](/Group), [MedicinalProductDefinition](/MedicinalProductDefinition), [SubstanceDefinition](/SubstanceDefinition), [AdministrableProductDefinition](/AdministrableProductDefinition), [ManufacturedItemDefinition](/ManufacturedItemDefinition), [PackagedProductDefinition](/PackagedProductDefinition)), [canonical](/canonical)

**Binding:** extensible:[participant-resource-types](/valueset-participant-resource-types)

**Mappings:** workflow=Definition.subject; rim=N/A (to add?) { only applies for subject Patient? }


<a id="ActivityDefinition.date"></a>

## ActivityDefinition.date
Date last changed

**Definition:** The date  (and optionally time) when the activity definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.

**Comments:** The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Aliases:** Revision Date

**Cardinality:** 0..1

**Type:** [dateTime](/dateTime)

**Summary:** true

**Mappings:** workflow=Definition.date; w5=FiveWs.recorded; rim=.participation[typeCode=AUT].time


<a id="ActivityDefinition.publisher"></a>

## ActivityDefinition.publisher
Name of the publisher/steward (organization or individual)

**Definition:** The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.

**Comments:** Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.

**Requirements:** Helps establish the "authority/credibility" of the activity definition.  May also allow for contact.

**Cardinality:** 0..1

**Type:** [string](/string)

**Summary:** true

**Mappings:** workflow=Definition.publisher {as string instead of CodeableConcept}; w5=FiveWs.witness; rim=.participation[typeCode=AUT].role


<a id="ActivityDefinition.contact"></a>

## ActivityDefinition.contact
Contact details for the publisher

**Definition:** Contact details to assist a user in finding and communicating with the publisher.

**Comments:** May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Summary:** true

**Mappings:** workflow=Definition.contact; rim=.participation[typeCode=CALLBCK].role


<a id="ActivityDefinition.description"></a>

## ActivityDefinition.description
Natural language description of the activity definition

**Definition:** A free text natural language description of the activity definition from a consumer's perspective.

**Comments:** This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).

**Cardinality:** 0..1

**Type:** [markdown](/markdown)

**Summary:** true

**Mappings:** workflow=Definition.description; rim=.text


<a id="ActivityDefinition.useContext"></a>

## ActivityDefinition.useContext
The context that the content is intended to support

**Definition:** The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.

**Comments:** When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

**Requirements:** Assist in searching for appropriate content.

**Cardinality:** 0..*

**Type:** [UsageContext](/UsageContext)

**Summary:** true

**Mappings:** workflow=Definition.useContext; rim=N/A (to add?)


<a id="ActivityDefinition.jurisdiction"></a>

## ActivityDefinition.jurisdiction
Jurisdiction of the authority that maintains the activity definition (if applicable)

**Definition:** A legal or geographic region in which the authority that maintains the resource is operating.  In general, the jurisdiction is also found in the useContext.  The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

**Comments:** It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element.  (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** extensible:[jurisdiction](/valueset-jurisdiction)

**Summary:** true

**Mappings:** workflow=Definition.jurisdiction; rim=N/A (to add?)


<a id="ActivityDefinition.purpose"></a>

## ActivityDefinition.purpose
Why this activity definition is defined

**Definition:** Explanation of why this activity definition is needed and why it has been designed as it has.

**Comments:** This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is.  This may be used to point to source materials or specifications that drove the structure of this activity definition.

**Cardinality:** 0..1

**Type:** [markdown](/markdown)

**Mappings:** workflow=Definition.purpose; w5=FiveWs.why[x]; rim=.reasonCode.text; objimpl=no-gen-base


<a id="ActivityDefinition.usage"></a>

## ActivityDefinition.usage
Describes the clinical usage of the activity definition

**Definition:** A detailed description of how the activity definition is used from a clinical perspective.

**Cardinality:** 0..1

**Type:** [markdown](/markdown)

**Mappings:** rim=N/A (to add?)


<a id="ActivityDefinition.copyright"></a>

## ActivityDefinition.copyright
Notice about intellectual property ownership, can include restrictions on use

**Definition:** A copyright statement relating to the activity definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the activity definition.

**Comments:** The short copyright declaration (e.g. (c) '2015+ xyz organization') should be sent in the copyrightLabel element without the copyright prefix (i.e., do not include '(c)' or the symbol).

**Requirements:** Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.

**Aliases:** License, Restrictions

**Cardinality:** 0..1

**Type:** [markdown](/markdown)

**Mappings:** workflow=Definition.copyright; rim=N/A (to add?); objimpl=no-gen-base


<a id="ActivityDefinition.copyrightLabel"></a>

## ActivityDefinition.copyrightLabel
Copyright holder and year(s)

**Definition:** A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

**Comments:** The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

**Requirements:** Defines the content expected to be rendered in all representations of the artifact.

**Cardinality:** 0..1

**Type:** [string](/string)

**Mappings:** workflow=Definition.copyrightLabel; rim=N/A (to add?); objimpl=no-gen-base


<a id="ActivityDefinition.approvalDate"></a>

## ActivityDefinition.approvalDate
When the activity definition was approved by publisher

**Definition:** The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

**Comments:** The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 0..1

**Type:** [date](/date)

**Mappings:** workflow=Definition.approvalDate; rim=.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime; objimpl=no-gen-base


<a id="ActivityDefinition.lastReviewDate"></a>

## ActivityDefinition.lastReviewDate
When the activity definition was last reviewed by the publisher

**Definition:** The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

**Comments:** If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Requirements:** Gives a sense of how "current" the content is.  Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

**Cardinality:** 0..1

**Type:** [date](/date)

**Mappings:** workflow=Definition.lastReviewDate; rim=.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime; objimpl=no-gen-base


<a id="ActivityDefinition.effectivePeriod"></a>

## ActivityDefinition.effectivePeriod
When the activity definition is expected to be used

**Definition:** The period during which the activity definition content was or is planned to be in active use.

**Comments:** The effective period for an activity definition  determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Requirements:** Allows establishing a transition before a resource comes into effect and also allows for a sunsetting  process when new versions of the activity definition are or are expected to be used instead.

**Cardinality:** 0..1

**Type:** [Period](/Period)

**Summary:** true

**Mappings:** workflow=Definition.effectivePeriod; rim=N/A (to add?); objimpl=no-gen-base


<a id="ActivityDefinition.topic"></a>

## ActivityDefinition.topic
E.g. Education, Treatment, Assessment, etc

**Definition:** Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.

**Comments:** DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element.  (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

**Requirements:** Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** example:[definition-topic](/valueset-definition-topic)

**Mappings:** rim=N/A (to add?)


<a id="ActivityDefinition.author"></a>

## ActivityDefinition.author
Who authored the content

**Definition:** An individiual or organization primarily involved in the creation and maintenance of the content.

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Mappings:** rim=.participation[typeCode=AUT]


<a id="ActivityDefinition.editor"></a>

## ActivityDefinition.editor
Who edited the content

**Definition:** An individual or organization primarily responsible for internal coherence of the content.

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Mappings:** rim=.participation[typeCode=AUT] { not a great match, but there does not appear to be an editor concept in V3 participation }


<a id="ActivityDefinition.reviewer"></a>

## ActivityDefinition.reviewer
Who reviewed the content

**Definition:** An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

**Comments:** See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Mappings:** rim=.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}


<a id="ActivityDefinition.endorser"></a>

## ActivityDefinition.endorser
Who endorsed the content

**Definition:** An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

**Comments:** See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).

**Cardinality:** 0..*

**Type:** [ContactDetail](/ContactDetail)

**Mappings:** rim=.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}


<a id="ActivityDefinition.relatedArtifact"></a>

## ActivityDefinition.relatedArtifact
Additional documentation, citations, etc

**Definition:** Related artifacts such as additional documentation, justification, or bibliographic references.

**Comments:** Each related artifact is either an attachment, or a reference to another resource, but not both. In addition, the successor or predecessor of an ActivityDefinition SHOULD be an ActivityDefinition, dependencies of an ActivityDefinition SHOULD reference a resource, and ActivityDefinition resources SHOULD NOT have components.

**Requirements:** Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

**Cardinality:** 0..*

**Type:** [RelatedArtifact](/RelatedArtifact)

**Constraints:** adf-2 | warning | Dependencies of an ActivityDefinition should reference a resource | type in ('depends-on' | 'part-of') implies ((resource.exists() xor resourceReference.exists()) or (artifact is canonical xor artifact is Reference)); adf-3 | warning | ActivityDefinition should not have components | type != 'composed-of'

**Mappings:** rim=.outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}


<a id="ActivityDefinition.library"></a>

## ActivityDefinition.library
Logic used by the activity definition

**Definition:** A reference to a Library resource containing any formal logic used by the activity definition.

**Cardinality:** 0..*

**Type:** [canonical](/canonical)

**Mappings:** rim=.outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]


<a id="ActivityDefinition.kind"></a>

## ActivityDefinition.kind
Kind of resource

**Definition:** A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

**Comments:** The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.

**Cardinality:** 0..1

**Type:** [code](/code)

**Binding:** required:[request-resource-types](/valueset-request-resource-types)

**Summary:** true

**Mappings:** rim=.classCode


<a id="ActivityDefinition.profile"></a>

## ActivityDefinition.profile
What profile the resource needs to conform to

**Definition:** A profile to which the target of the activity definition is expected to conform.

**Requirements:** Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.

**Cardinality:** 0..1

**Type:** [canonical](/canonical)

**Mappings:** rim=.templateId


<a id="ActivityDefinition.code"></a>

## ActivityDefinition.code
Detail type of activity

**Definition:** Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

**Comments:** Tends to be less relevant for activities involving particular products.

**Requirements:** Allows matching performed to planned as well as validation against protocols.

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** example:[procedure-code](/valueset-procedure-code)

**Summary:** true

**Mappings:** rim=.code


<a id="ActivityDefinition.intent"></a>

## ActivityDefinition.intent
proposal | solicit-offer | offer-response | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

**Definition:** Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

**Cardinality:** 0..1

**Type:** [code](/code)

**Binding:** required:[request-intent](/valueset-request-intent)

**Mappings:** rim=.moodCode { of the realized Activity }


<a id="ActivityDefinition.priority"></a>

## ActivityDefinition.priority
routine | urgent | asap | stat

**Definition:** Indicates how quickly the activity  should be addressed with respect to other requests.

**Cardinality:** 0..1

**Type:** [code](/code)

**Binding:** required:[request-priority](/valueset-request-priority)

**Mappings:** rim=.priority { of the realized activity }


<a id="ActivityDefinition.doNotPerform"></a>

## ActivityDefinition.doNotPerform
True if the activity should not be performed

**Definition:** Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.

**Comments:** This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration.

**Cardinality:** 0..1

**Type:** [boolean](/boolean)

**Summary:** true

**Is Modifier:** true (Reason: If true this element negates the specified action. For Example,  instead of a request for a procedure, it is a request for the procedure to not occur.)

**Mappings:** rim=.negationInd { of the realized activity }


<a id="ActivityDefinition.timing[x]"></a>

## ActivityDefinition.timing[x]
When activity is to occur

**Definition:** The timing or frequency upon which the described activity is to occur.

**Comments:** The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

**Requirements:** Allows prompting for activities and detection of missed planned activities.

**Cardinality:** 0..1

**Type:** [Timing](/Timing), [Age](/Age), [Range](/Range), [Duration](/Duration), [RelativeTime](/RelativeTime)

**Mappings:** rim=.effectiveTime


<a id="ActivityDefinition.asNeeded[x]"></a>

## ActivityDefinition.asNeeded[x]
Preconditions for service

**Definition:** If a CodeableConcept is present, it indicates the pre-condition for performing the service.  For example "pain", "on flare-up", etc.

**Cardinality:** 0..1

**Type:** [boolean](/boolean), [CodeableConcept](/CodeableConcept)

**Binding:** example:[medication-as-needed-reason](/valueset-medication-as-needed-reason)

**Summary:** true

**Mappings:** rim=boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code="Assertion"].value


<a id="ActivityDefinition.location"></a>

## ActivityDefinition.location
Where it should happen

**Definition:** Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

**Comments:** May reference a specific clinical location or may just identify a type of location.

**Requirements:** Helps in planning of activity.

**Aliases:** facility

**Cardinality:** 0..1

**Type:** [CodeableReference](/CodeableReference)

**Mappings:** rim=.participation[typeCode=LOC].role


<a id="ActivityDefinition.participant"></a>

## ActivityDefinition.participant
Who should participate in the action

**Definition:** Indicates who should participate in performing the action described.

**Cardinality:** 0..*

**Type:** [BackboneElement](/BackboneElement)

**Mappings:** rim=.participation[typeCode=PFM]


<a id="ActivityDefinition.participant.type"></a>

## ActivityDefinition.participant.type
careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson

**Definition:** The type of participant in the action.

**Cardinality:** 0..1

**Type:** [code](/code)

**Binding:** required:[action-participant-type](/valueset-action-participant-type)

**Mappings:** rim=.role.classCode


<a id="ActivityDefinition.participant.typeCanonical"></a>

## ActivityDefinition.participant.typeCanonical
Who or what can participate

**Definition:** The type of participant in the action.

**Cardinality:** 0..1

**Type:** [canonical](/canonical)

**Mappings:** rim=.role.classCode


<a id="ActivityDefinition.participant.typeReference"></a>

## ActivityDefinition.participant.typeReference
Who or what can participate

**Definition:** The type of participant in the action.

**Comments:** When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). Note that specimen as a participant in cell-line research is acceptable, but specimen in clinical research would typically be represented as the focus rather the subject.

**Cardinality:** 0..1

**Type:** Reference([BiologicallyDerivedProduct](/BiologicallyDerivedProduct), [CareTeam](/CareTeam), [Device](/Device), [Endpoint](/Endpoint), [HealthcareService](/HealthcareService), [Location](/Location), [Medication](/Medication), [MedicinalProductDefinition](/MedicinalProductDefinition), [Organization](/Organization), [Patient](/Patient), [Practitioner](/Practitioner), [PractitionerRole](/PractitionerRole), [RelatedPerson](/RelatedPerson), [Specimen](/Specimen), [Substance](/Substance), [SubstanceDefinition](/SubstanceDefinition))

**Mappings:** rim=.role.classCode


<a id="ActivityDefinition.participant.role"></a>

## ActivityDefinition.participant.role
E.g. Nurse, Surgeon, Parent, etc

**Definition:** The role the participant should play in performing the described action.

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** example:[action-participant-role](/valueset-action-participant-role)

**Mappings:** rim=.role.code


<a id="ActivityDefinition.participant.function"></a>

## ActivityDefinition.participant.function
E.g. Author, Reviewer, Witness, etc

**Definition:** Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

**Cardinality:** 0..1

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** example:[action-participant-function](/valueset-action-participant-function)

**Mappings:** rim=.role.code


<a id="ActivityDefinition.product[x]"></a>

## ActivityDefinition.product[x]
What's administered/supplied

**Definition:** Identifies the food, drug or other product being consumed or supplied in the activity.

**Cardinality:** 0..1

**Type:** Reference([Medication](/Medication), [MedicinalProductDefinition](/MedicinalProductDefinition), [Ingredient](/Ingredient), [SubstanceDefinition](/SubstanceDefinition)), [CodeableConcept](/CodeableConcept)

**Binding:** example:[medication-codes](/valueset-medication-codes)

**Mappings:** rim=.participation[typeCode=CSM].role


<a id="ActivityDefinition.quantity"></a>

## ActivityDefinition.quantity
How much is administered/consumed/supplied

**Definition:** Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

**Aliases:** dose

**Cardinality:** 0..1

**Type:** [Quantity](/Quantity)([SimpleQuantity](/SimpleQuantity))

**Mappings:** rim=.quantity {for classCode=SPLY}


<a id="ActivityDefinition.dosage"></a>

## ActivityDefinition.dosage
Detailed dosage instructions

**Definition:** Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

**Comments:** If a dosage instruction is used, the definition should not specify timing or quantity.

**Cardinality:** 0..*

**Type:** [Dosage](/Dosage)

**Mappings:** rim=.outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]


<a id="ActivityDefinition.bodySite"></a>

## ActivityDefinition.bodySite
What part of body to perform on

**Definition:** Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

**Comments:** Only used if not implicit in the code found in ServiceRequest.type.

**Requirements:** Knowing where the procedure is made is important for tracking if multiple sites are possible.

**Cardinality:** 0..*

**Type:** [CodeableConcept](/CodeableConcept)

**Binding:** example:[body-site](/valueset-body-site)

**Mappings:** rim=.targetSiteCode {for classCode=PROC, SBADM}


<a id="ActivityDefinition.specimenRequirement"></a>

## ActivityDefinition.specimenRequirement
What specimens are required to perform this action

**Definition:** Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

**Requirements:** Needed to represent lab order definitions.

**Cardinality:** 0..*

**Type:** [canonical](/canonical)

**Mappings:** rim=N/A


<a id="ActivityDefinition.observationRequirement"></a>

## ActivityDefinition.observationRequirement
What observations are required to perform this action

**Definition:** Defines observation requirements for the action to be performed, such as body weight or surface area.

**Requirements:** Needed to represent observation definitions.

**Cardinality:** 0..*

**Type:** [canonical](/canonical)

**Mappings:** rim=N/A


<a id="ActivityDefinition.observationResultRequirement"></a>

## ActivityDefinition.observationResultRequirement
What observations must be produced by this action

**Definition:** Defines the observations that are expected to be produced by the action.

**Cardinality:** 0..*

**Type:** [canonical](/canonical)

**Mappings:** rim=N/A


<a id="ActivityDefinition.transform"></a>

## ActivityDefinition.transform
Transform to apply the template

**Definition:** A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

**Comments:** Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

**Cardinality:** 0..1

**Type:** [canonical](/canonical)

**Mappings:** rim=N/A


<a id="ActivityDefinition.dynamicValue"></a>

## ActivityDefinition.dynamicValue
Dynamic aspects of the definition

**Definition:** Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

**Comments:** Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

**Cardinality:** 0..*

**Type:** [BackboneElement](/BackboneElement)

**Mappings:** rim=N/A


<a id="ActivityDefinition.dynamicValue.path"></a>

## ActivityDefinition.dynamicValue.path
The path to the element to be set dynamically

**Definition:** The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

**Comments:** The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.

**Cardinality:** 1..1

**Type:** [string](/string)

**Mappings:** rim=N/A


<a id="ActivityDefinition.dynamicValue.expression"></a>

## ActivityDefinition.dynamicValue.expression
An expression that provides the dynamic value for the customization

**Definition:** An expression specifying the value of the customized element.

**Comments:** The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

**Cardinality:** 1..1

**Type:** [Expression](/Expression)

**Mappings:** rim=N/A