# ActivityDefinition

Canonical page: https://docs.ovok.com/api/fhir/r4/activity-definition

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/ActivityDefinition/[id]` |
| Vread | `GET` | `/fhir/R4/ActivityDefinition/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ActivityDefinition/[id]` |
| Patch | `PATCH` | `/fhir/R4/ActivityDefinition/[id]` |
| Delete | `DELETE` | `/fhir/R4/ActivityDefinition/[id]` |
| Create | `POST` | `/fhir/R4/ActivityDefinition` |
| Search | `GET` | `/fhir/R4/ActivityDefinition` |
| History | `GET` | `/fhir/R4/ActivityDefinition/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Canonical identifier for this activity definition, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the activity definition |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the activity definition |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this activity definition (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this activity definition (human friendly) |
| <span id="element-subtitle"></span>`subtitle` | [string](/fhir-elements/primitive/string) | `0..1` | Subordinate title of the activity definition |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-subject-x"></span>`subject[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `0..1` | Type of individual the activity definition is intended for |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the activity definition |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for activity definition (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this activity definition is defined |
| <span id="element-usage"></span>`usage` | [string](/fhir-elements/primitive/string) | `0..1` | Describes the clinical usage of the activity definition |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the activity definition was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the activity definition was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the activity definition is expected to be used |
| <span id="element-topic"></span>`topic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | E.g. Education, Treatment, Assessment, etc. |
| <span id="element-author"></span>`author` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who authored the content |
| <span id="element-editor"></span>`editor` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who edited the content |
| <span id="element-reviewer"></span>`reviewer` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who reviewed the content |
| <span id="element-endorser"></span>`endorser` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who endorsed the content |
| <span id="element-related-artifact"></span>`relatedArtifact` | [RelatedArtifact](/fhir-elements/complex/related-artifact) | `0..*` | Additional documentation, citations, etc. |
| <span id="element-library"></span>`library` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Logic used by the activity definition |
| <span id="element-kind"></span>`kind` | [code](/fhir-elements/primitive/code) | `0..1` | Kind of resource |
| <span id="element-profile"></span>`profile` | [canonical](/fhir-elements/primitive/canonical) | `0..1` | What profile the resource needs to conform to |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Detail type of activity |
| <span id="element-intent"></span>`intent` | [code](/fhir-elements/primitive/code) | `0..1` | proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-do-not-perform"></span>`doNotPerform` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | True if the activity should not be performed |
| <span id="element-timing-x"></span>`timing[x]` | [Timing](/fhir-elements/complex/timing), [dateTime](/fhir-elements/primitive/date-time), [Age](/fhir-elements/complex/age), [Period](/fhir-elements/complex/period), [Range](/fhir-elements/complex/range), [Duration](/fhir-elements/complex/duration) | `0..1` | When activity is to occur |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..1` | Where it should happen |
| <span id="element-participant"></span>`participant` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Who should participate in the action |
| <span id="element-product-x"></span>`product[x]` | [Reference](/fhir-elements/complex/reference), [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | What's administered/supplied |
| <span id="element-quantity"></span>`quantity` | [Quantity](/fhir-elements/complex/quantity) | `0..1` | How much is administered/consumed/supplied |
| <span id="element-dosage"></span>`dosage` | [Dosage](/fhir-elements/complex/dosage) | `0..*` | Detailed dosage instructions |
| <span id="element-body-site"></span>`bodySite` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | What part of body to perform on |
| <span id="element-specimen-requirement"></span>`specimenRequirement` | [Reference](/fhir-elements/complex/reference) | `0..*` | What specimens are required to perform this action |
| <span id="element-observation-requirement"></span>`observationRequirement` | [Reference](/fhir-elements/complex/reference) | `0..*` | What observations are required to perform this action |
| <span id="element-observation-result-requirement"></span>`observationResultRequirement` | [Reference](/fhir-elements/complex/reference) | `0..*` | What observations must be produced by this action |
| <span id="element-transform"></span>`transform` | [canonical](/fhir-elements/primitive/canonical) | `0..1` | Transform to apply the template |
| <span id="element-dynamic-value"></span>`dynamicValue` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Dynamic aspects of the definition |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `composed-of` | reference | What resource is being referenced |
| `context` | token | A use context assigned to the activity definition |
| `context-quantity` | quantity | A quantity- or range-valued use context assigned to the activity definition |
| `context-type` | token | A type of use context assigned to the activity definition |
| `context-type-quantity` | composite | A use context type and quantity- or range-based value assigned to the activity definition |
| `context-type-value` | composite | A use context type and value assigned to the activity definition |
| `date` | date | The activity definition publication date |
| `depends-on` | reference | What resource is being referenced |
| `derived-from` | reference | What resource is being referenced |
| `description` | string | The description of the activity definition |
| `effective` | date | The time during which the activity definition is intended to be in use |
| `identifier` | token | External identifier for the activity definition |
| `jurisdiction` | token | Intended jurisdiction for the activity definition |
| `name` | string | Computationally friendly name of the activity definition |
| `predecessor` | reference | What resource is being referenced |
| `publisher` | string | Name of the publisher of the activity definition |
| `status` | token | The current status of the activity definition |
| `successor` | reference | What resource is being referenced |
| `title` | string | The human-friendly name of the activity definition |
| `topic` | token | Topics associated with the module |
| `url` | uri | The uri that identifies the activity definition |
| `version` | token | The business version of the activity definition |

## Reference [#reference]

Official FHIR R4 spec: [ActivityDefinition](https://hl7.org/fhir/R4/activitydefinition.html).  
Maturity: Trial Use 2 (FMM 2).
