FHIRResources
ActivityDefinition
| Maturity Level | Security Category | Resource Category |
|---|---|---|
| 2 | Anonymous | Specialized |
ActivityDefinition allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
Resource Content
Name | Required | Type | Description & Constraints |
|---|---|---|---|
| url | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | |
| identifier | Identifier[] | Additional identifier for the activity definition | |
| version | string | Business version of the activity definition | |
| name | string | Name for this activity definition (computer friendly) | |
| title | string | Name for this activity definition (human friendly) | |
| subtitle | string | Subordinate title of the activity definition | |
| status | ✓ | code | draft | active | retired | unknown |
| experimental | boolean | For testing purposes, not real usage | |
| subject[x] | See sub-fields | Type of individual the activity definition is intended for | |
| └─ subjectCodeableConcept | CodeableConcept | Type of individual specified as a coded concept | |
| └─ subjectReference | Reference<Group> | Type of individual specified as a group reference | |
| date | dateTime | Date last changed | |
| publisher | string | Name of the publisher (organization or individual) | |
| contact | ContactDetail[] | Contact details for the publisher | |
| description | markdown | Natural language description of the activity definition | |
| useContext | UsageContext[] | The context that the content is intended to support | |
| jurisdiction | CodeableConcept[] | Intended jurisdiction for activity definition | |
| purpose | markdown | Why this activity definition is defined | |
| usage | string | Describes the clinical usage of the activity definition | |
| copyright | markdown | Use and/or publishing restrictions | |
| approvalDate | date | When the activity definition was approved by publisher | |
| lastReviewDate | date | When the activity definition was last reviewed | |
| effectivePeriod | Period | When the activity definition is expected to be used | |
| topic | CodeableConcept[] | E.g. Education, Treatment, Assessment, etc. | |
| author | ContactDetail[] | Who authored the content | |
| editor | ContactDetail[] | Who edited the content | |
| reviewer | ContactDetail[] | Who reviewed the content | |
| endorser | ContactDetail[] | Who endorsed the content | |
| relatedArtifact | RelatedArtifact[] | Additional documentation, citations, etc. | |
| library | canonical<Library>[] | Logic used by the activity definition | |
| kind | code | Kind of resource | |
| profile | canonical<StructureDefinition> | What profile the resource needs to conform to | |
| code | CodeableConcept | Detail type of activity | |
| intent | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | |
| priority | code | routine | urgent | asap | stat | |
| doNotPerform | boolean | True if the activity should not be performed | |
| timing[x] | Timing | dateTime | Age | Period | Range | Duration | When activity is to occur | |
| location | Reference<Location> | Where it should happen | |
| participant | BackboneElement | Who should participate in the action | |
| └─ type | ✓ | code | patient | practitioner | related-person | device |
| └─ role | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. | |
| product[x] | Reference<Medication|Substance> | CodeableConcept | What's administered/supplied | |
| quantity | SimpleQuantity | How much is administered/consumed/supplied | |
| dosage | Dosage[] | Detailed dosage instructions | |
| bodySite | CodeableConcept[] | What part of body to perform on | |
| specimenRequirement | Reference<SpecimenDefinition>[] | What specimens are required to perform this action | |
| observationRequirement | Reference<ObservationDefinition>[] | What observations are required to perform this action | |
| observationResultRequirement | Reference<ObservationDefinition>[] | What observations must be produced by this action | |
| transform | canonical<StructureMap> | Transform to apply the template | |
| dynamicValue | BackboneElement | Dynamic aspects of the definition | |
| └─ path | ✓ | string | The path to the element to be set dynamically |
| └─ expression | ✓ | Expression | An expression that provides the dynamic value for the customization |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composed-of | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type = 'composed-of').resource |
| context | token | A use context assigned to the activity definition | ActivityDefinition.useContext.value as CodeableConcept |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition | ActivityDefinition.useContext.value as Quantity | ActivityDefinition.useContext.value as Range |
| context-type | token | A type of use context assigned to the activity definition | ActivityDefinition.useContext.code |
| date | date | The activity definition publication date | ActivityDefinition.date |
| depends-on | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type = 'depends-on').resource | ActivityDefinition.library |
| derived-from | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type = 'derived-from').resource |
| description | string | The description of the activity definition | ActivityDefinition.description |
| effective | date | The time during which the activity definition is intended to be in use | ActivityDefinition.effectivePeriod |
| identifier | token | External identifier for the activity definition | ActivityDefinition.identifier |
| jurisdiction | token | Intended jurisdiction for the activity definition | ActivityDefinition.jurisdiction |
| name | string | Computationally friendly name of the activity definition | ActivityDefinition.name |
| predecessor | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type = 'predecessor').resource |
| publisher | string | Name of the publisher of the activity definition | ActivityDefinition.publisher |
| status | token | The current status of the activity definition | ActivityDefinition.status |
| successor | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type = 'successor').resource |
| title | string | The human-friendly name of the activity definition | ActivityDefinition.title |
| topic | token | Topics associated with the module | ActivityDefinition.topic |
| url | uri | The uri that identifies the activity definition | ActivityDefinition.url |
| version | token | The business version of the activity definition | ActivityDefinition.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition | ActivityDefinition.useContext |
| context-type-value | composite | A use context type and value assigned to the activity definition | ActivityDefinition.useContext |
Scope and Usage
An ActivityDefinition is a shareable, consumable description of some activity to be performed. It may be used to specify actions to be taken as part of a workflow, order set, or protocol, or it may be used independently as part of a catalog of activities such as orderables.
For more information on how activity definitions can be used to construct request resources, see the Applying an ActivityDefinition topic below.
Boundaries and Relationships
In general, an activity definition is simply a conceptual description of some specific action that should be taken. An instance of an ActivityDefinition does not indicate that any action has been performed (as an event resource does), nor does it indicate the actual intent to carry out any particular action (as a request resource does). Instead, an activity definition provides a reusable template that can be used to construct specific request resources such as ServiceRequest and MedicationRequest.
Note that this is conceptually similar to the Task resource as well, with the distinction being that ActivityDefinition represents the description of a task in the abstract, while the Task resource is used to track a specific instance of a task as it moves through the steps of a workflow.
Referenced Elements
This resource is referenced by: