This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Detailed Descriptions for the elements in the ActivityDefinition resource.
ActivityDefinition | |
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. |
Control | 1..1 |
ActivityDefinition.url | |
Definition | An absolute URL that is used to identify this asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) published. |
Control | 0..1 |
Type | uri |
Requirements | Allows the asset to be referenced by a single globally unique identifier. |
Summary | true |
ActivityDefinition.identifier | |
Definition | A logical identifier for the asset such as the CMS or NQF identifiers for a measure. Note that at least one identifier is required for non-experimental active assets. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows external business identifiers to be easily associated with the asset. |
Summary | true |
To Do | Add constraint to require identifier for non-experimental active assets. |
ActivityDefinition.version | |
Definition | The version of the asset, if any. 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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Requirements | Allows for versioning of the content of the asset. |
Summary | true |
To Do | Add constraint to require version for non-experimental active assets. |
ActivityDefinition.name | |
Definition | A machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generation. |
Control | 0..1 |
Type | string |
Requirements | Simplifies machine-processing tasks related to the asset such as code-generation or logging. |
Summary | true |
Comments | This identifier for the asset should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z][A-Za-z0-9]*). |
ActivityDefinition.title | |
Definition | A short, descriptive, user-friendly title for the asset. |
Control | 0..1 |
Type | string |
Summary | true |
ActivityDefinition.status | |
Definition | The status of the asset. |
Control | 1..1 |
Binding | LibraryStatus: The status of the ActivityDefinition (Required) |
Type | code |
Is Modifier | true |
Requirements | Enables tracking the life-cycle of the content of the asset. |
Summary | true |
ActivityDefinition.experimental | |
Definition | Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level asset would. |
Summary | true |
ActivityDefinition.description | |
Definition | A free text natural language description of the asset from the consumer's perspective. |
Control | 0..1 |
Type | string |
Comments | This description can be used to capture details such as why the asset was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the asset as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. |
ActivityDefinition.purpose | |
Definition | A brief description of the purpose of the asset. |
Control | 0..1 |
Type | string |
Comments | This description should address the question of why this asset was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element. |
ActivityDefinition.usage | |
Definition | A detailed description of how the asset is used from a clinical perspective. |
Control | 0..1 |
Type | string |
ActivityDefinition.publicationDate | |
Definition | The date on which the asset was published. |
Control | 0..1 |
Type | date |
ActivityDefinition.lastReviewDate | |
Definition | The date on which the asset content was last reviewed. |
Control | 0..1 |
Type | date |
ActivityDefinition.effectivePeriod | |
Definition | The period during which the asset content is effective. |
Control | 0..1 |
Type | Period |
Comments | The effective period for an asset determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015. |
ActivityDefinition.coverage | |
Definition | Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge asset is applicable. |
Control | 0..* |
Type | UsageContext |
Requirements | Consumers of the asset must be able to determine the intended applicability for the asset. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed. |
ActivityDefinition.topic | |
Definition | Clinical topics related to the content of the asset. |
Control | 0..* |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. |
ActivityDefinition.contributor | |
Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. |
Control | 0..* |
Type | Contributor |
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset. |
ActivityDefinition.publisher | |
Definition | The name of the individual or organization that published the asset (also known as the steward for the asset). This information is required for non-experimental active artifacts. |
Control | 0..1 |
Type | string |
Requirements | Consumers of the asset must be able to determine where to obtain support in the use of this asset, as well as where to direct questions and concerns about the content. |
Comments | The publisher (or steward) of the module is the organization or individual primarily responsible for the maintenance and upkeep of the module. This is not necessarily the same organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the module. |
To Do | Add constraint to require publisher on non-experimental active assets. |
ActivityDefinition.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
ActivityDefinition.copyright | |
Definition | A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the asset. |
Control | 0..1 |
Type | string |
Requirements | Consumers of the asset must be able to determine any legal restrictions on the use of the asset and/or its content. |
ActivityDefinition.relatedResource | |
Definition | Related resources such as additional documentation, justification, or bibliographic references. |
Control | 0..* |
Type | RelatedResource |
Requirements | Assets 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. |
Comments | Each related resource is either an attachment, or a reference to another resource, but not both. |
ActivityDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the asset. |
Control | 0..* |
Type | Reference(Library) |
ActivityDefinition.category | |
Definition | High-level categorization of the type of activity. |
Control | 0..1 |
Binding | ActivityDefinitionCategory: High-level categorization of the type of activity in a protocol. (Required) |
Type | code |
Requirements | May determine what types of extensions are permitted. |
ActivityDefinition.code | |
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
Control | 0..1 |
Binding | ActivityDefinitionType: Detailed type of planned activity; e.g. CBC |
Type | CodeableConcept |
Requirements | Allows matching performed to planned as well as validation against protocols. |
Comments | Tends to be less relevant for activities involving particular products. |
ActivityDefinition.timing[x] | |
Definition | The period, timing or frequency upon which the described activity is to occur. |
Control | 0..1 |
Binding | ActivityTiming: Code describing the timing of an activity; e.g. BID, QD |
Type | CodeableConcept|Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Allows prompting for activities and detection of missed planned activities. |
ActivityDefinition.location | |
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
Control | 0..1 |
Type | Reference(Location) |
Requirements | Helps in planning of activity. |
Alternate Names | facility |
Comments | May reference a specific clinical location or may just identify a type of location. |
ActivityDefinition.participantType | |
Definition | The type of participant in the action. |
Control | 0..* |
Binding | PlanActionParticipantType: The type of participant for an action in the orderset (Required) |
Type | code |
ActivityDefinition.product[x] | |
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. |
Control | 0..1 |
Binding | ActivityProduct: Code describing the type of substance or medication |
Type | Reference(Medication | Substance)|CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ActivityDefinition.quantity | |
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
Control | 0..1 |
Type | SimpleQuantity |
Alternate Names | dose |
ActivityDefinition.transform | |
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. |
Control | 0..1 |
Type | Reference(StructureMap) |
ActivityDefinition.dynamicValue | |
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 intent resource that would contain the result. |
Control | 0..* |
ActivityDefinition.dynamicValue.description | |
Definition | A brief, natural language description of the intended semantics of the dynamic value. |
Control | 0..1 |
Type | string |
ActivityDefinition.dynamicValue.path | |
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. |
Control | 0..1 |
Type | string |
ActivityDefinition.dynamicValue.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
ActivityDefinition.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |