Resource type: activitydefinition

Description

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

Elements

PathShortDefinitionComments
The definition of a specific activity to be taken, independent of any particular patient or contextThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
urlCanonical identifier for this activity definition, represented as a URI (globally unique)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 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.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.
identifierAdditional identifier for the activity definitionA 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.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the activity definitionThe 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.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].
nameName for this activity definition (computer friendly)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.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.
titleName for this activity definition (human friendly)A short, descriptive, user-friendly title for the activity definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the activity definitionAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft | active | retired | unknownThe status of this activity definition. Enables tracking the life-cycle of the content.Allows filtering of activity definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.Allows filtering of activity definitions that are appropriate for use versus not.
subject[x]Type of individual the activity definition is intended forA code or group definition that describes the intended subject of the activity being defined.
dateDate last changedThe date (and optionally time) when the activity definition was published. 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.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.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the activity definition.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.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the activity definitionA free text natural language description of the activity definition from a consumer's perspective.This description can be used to capture details such as why the activity definition 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 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).
useContextThe context that the content is intended to supportThe 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.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for activity definition (if applicable)A legal or geographic region in which the activity definition is intended to be used.It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this activity definition is definedExplanation of why this activity definition is needed and why it has been designed as it has.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.
usageDescribes the clinical usage of the activity definitionA detailed description of how the activity definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDateWhen the activity definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the activity definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the activity definition is expected to be usedThe period during which the activity definition content was or is planned to be in active use.The effective period for a activity definition 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 might be published in 2015.
topicE.g. Education, Treatment, Assessment, etc.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.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citations, etc.Related artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the activity definitionA reference to a Library resource containing any formal logic used by the activity definition.
kindKind of resourceA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.May determine what types of extensions are permitted.
profileWhat profile the resource needs to conform toA profile to which the target of the activity definition is expected to conform.
codeDetail type of activityDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.Tends to be less relevant for activities involving particular products.
intentproposal | plan | orderIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
priorityroutine | urgent | asap | statIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformTrue if the activity should not be performedSet 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.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 RequestGroup.
timing[x]When activity is to occurThe period, timing or frequency upon which the described activity is to occur.
locationWhere it should happenIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.May reference a specific clinical location or may just identify a type of location.
participantWho should participate in the actionIndicates who should participate in performing the action described.
participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
participant.roleE.g. Nurse, Surgeon, Parent, etc.The role the participant should play in performing the described action.
product[x]What's administered/suppliedIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityHow much is administered/consumed/suppliedIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosageDetailed dosage instructionsProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources.If a dosage instruction is used, the definition should not specify timing or quantity.
bodySiteWhat part of body to perform onIndicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).Only used if not implicit in the code found in ServiceRequest.type.
specimenRequirementWhat specimens are required to perform this actionDefines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementWhat observations are required to perform this actionDefines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementWhat observations must be produced by this actionDefines the observations that are expected to be produced by the action.
transformTransform to apply the templateA 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.Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
dynamicValueDynamic aspects of the definitionDynamic 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.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.
dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
dynamicValue.pathThe path to the element to be set dynamicallyThe 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 resolveable 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).The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

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.

Applying an ActivityDefinition

An ActivityDefinition resource provides a description, or template, of an action to performed. These actions can be purely text-based descriptions of the action to be performed, only interpretable by a human user, or they can be structured definitions with enough information to construct a resource to represent the request or activity directly. This process of converting the ActivityDefinition into a specific resource in a particular context is performed with the $apply operation.

In the simplest case, the process maps the elements specified in the ActivityDefinition to the corresponding elements on a resource of the appropriate type, using the kind element of the definition to determine the type of resource to be created.

More dynamic scenarios can be achieved in one of two ways, either by providing dynamicValue expressions, or by specifying a StructureMap that transforms the definition into the appropriate request resource.

Note that systems will likely vary widely in the degree of support they provide for the $apply operation. In particular, the fact that a system supports applying definitions of one category, does not imply that it supports applying definitions for all categories. For example, a service focused on medication order sets may have sophisticated support for MedicationRequest activities, but no support at all for the ServiceRequest activities.

The following diagram illustrates the relationship between the PlanDefinition and ActivityDefinition resources, as well as a typical application to CarePlan, RequestGroup, and Request resources:

relationship-between-action-and-activity-definition

To accommodate the variability in systems and use cases, this specification is not prescriptive about exactly how an ActivityDefinition is applied to produce target request or event resources. However, the approach depicted above provides a general framework for the process, and the following steps provide more detail on the potential approach:

  1. Create the target resource of the type specified by the kind element and focused on the Patient in context
  2. Set the status of the target resource to draft
  3. Apply the structural elements of the ActivityDefinition to the target resource such as code, timing, doNotPerform, product, quantity, dosage, and so on
  4. Resolve the participant element based on the user in context
  5. Resolve the location element based on the location in context
  6. If the transform element is specified, apply the transform to the resource. Note that the referenced StructureMap may actually construct the resource, rather than taking an instance. See the StructureMap for more information
  7. Apply any dynamicValue elements (in the order in which they appear in the ActivityDefinition resource) by evaluating the expression and setting the value of the appropriate element of the target resource (as specified by the dynamicValue.path element)

Note that the parameters to the $apply operation are available within dynamicValue CQL and FHIRPath expressions as context variables, accessible by the name of the parameter prefixed with a percent (%) symbol. For example, to access the subject given to the apply, use the expression %subject.

Profiling ActivityDefinition

Because the ActivityDefinition resource can be used to describe many different types of request resources, profiles of the resource will be useful in communicating additional constraints and expectations about how the resource should be used in a particular context. For example, a profile of ActivityDefinition may specify that it is intended to describe medication orders within an order set. Such a profile would indicate that the quantity element should not be used, but the dosage element must be.

Search Parameters

composed-ofWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='composed-of').resource
contextA use context assigned to the activity definition(ActivityDefinition.useContext.value as CodeableConcept)
context-quantityA quantity- or range-valued use context assigned to the activity definition(ActivityDefinition.useContext.value as Quantity) | (ActivityDefinition.useContext.value as Range)
context-typeA type of use context assigned to the activity definitionActivityDefinition.useContext.code
dateThe activity definition publication dateActivityDefinition.date
depends-onWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library
derived-fromWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='derived-from').resource
descriptionThe description of the activity definitionActivityDefinition.description
effectiveThe time during which the activity definition is intended to be in useActivityDefinition.effectivePeriod
identifierExternal identifier for the activity definitionActivityDefinition.identifier
jurisdictionIntended jurisdiction for the activity definitionActivityDefinition.jurisdiction
nameComputationally friendly name of the activity definitionActivityDefinition.name
predecessorWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='predecessor').resource
publisherName of the publisher of the activity definitionActivityDefinition.publisher
statusThe current status of the activity definitionActivityDefinition.status
successorWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='successor').resource
titleThe human-friendly name of the activity definitionActivityDefinition.title
topicTopics associated with the moduleActivityDefinition.topic
urlThe uri that identifies the activity definitionActivityDefinition.url
versionThe business version of the activity definitionActivityDefinition.version
context-type-quantityA use context type and quantity- or range-based value assigned to the activity definitionActivityDefinition.useContext
context-type-valueA use context type and value assigned to the activity definitionActivityDefinition.useContext

Extension Definitions

These are extension definitions for this resource defined by the spec

Profiles based on this resource

Shareable ActivityDefinition

Enforces the minimum information set for the activity definition metadata required by HL7 and other organizations that share and publish activity definitions

Elements

PathShortDefinitionComments
The definition of a specific activity to be taken, independent of any particular patient or contextThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
urlCanonical identifier for this activity definition, represented as a URI (globally unique)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 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.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.
identifierAdditional identifier for the activity definitionA 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.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the activity definitionThe 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.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].
nameName for this activity definition (computer friendly)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.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.
titleName for this activity definition (human friendly)A short, descriptive, user-friendly title for the activity definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the activity definitionAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft | active | retired | unknownThe status of this activity definition. Enables tracking the life-cycle of the content.Allows filtering of activity definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.Allows filtering of activity definitions that are appropriate for use versus not.
subject[x]Type of individual the activity definition is intended forA code or group definition that describes the intended subject of the activity being defined.
dateDate last changedThe date (and optionally time) when the activity definition was published. 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.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.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the activity definition.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.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the activity definitionA free text natural language description of the activity definition from a consumer's perspective.This description can be used to capture details such as why the activity definition 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 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).
useContextThe context that the content is intended to supportThe 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.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for activity definition (if applicable)A legal or geographic region in which the activity definition is intended to be used.It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this activity definition is definedExplanation of why this activity definition is needed and why it has been designed as it has.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.
usageDescribes the clinical usage of the activity definitionA detailed description of how the activity definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDateWhen the activity definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the activity definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the activity definition is expected to be usedThe period during which the activity definition content was or is planned to be in active use.The effective period for a activity definition 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 might be published in 2015.
topicE.g. Education, Treatment, Assessment, etc.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.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citations, etc.Related artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the activity definitionA reference to a Library resource containing any formal logic used by the activity definition.
kindKind of resourceA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.May determine what types of extensions are permitted.
profileWhat profile the resource needs to conform toA profile to which the target of the activity definition is expected to conform.
codeDetail type of activityDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.Tends to be less relevant for activities involving particular products.
intentproposal | plan | orderIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
priorityroutine | urgent | asap | statIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformTrue if the activity should not be performedSet 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.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 RequestGroup.
timing[x]When activity is to occurThe period, timing or frequency upon which the described activity is to occur.
locationWhere it should happenIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.May reference a specific clinical location or may just identify a type of location.
participantWho should participate in the actionIndicates who should participate in performing the action described.
participant.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
participant.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
participant.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
participant.typepatient | practitioner | related-person | deviceThe type of participant in the action.
participant.roleE.g. Nurse, Surgeon, Parent, etc.The role the participant should play in performing the described action.
product[x]What's administered/suppliedIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityHow much is administered/consumed/suppliedIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosageDetailed dosage instructionsProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources.If a dosage instruction is used, the definition should not specify timing or quantity.
bodySiteWhat part of body to perform onIndicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).Only used if not implicit in the code found in ServiceRequest.type.
specimenRequirementWhat specimens are required to perform this actionDefines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementWhat observations are required to perform this actionDefines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementWhat observations must be produced by this actionDefines the observations that are expected to be produced by the action.
transformTransform to apply the templateA 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.Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
dynamicValueDynamic aspects of the definitionDynamic 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.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.
dynamicValue.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
dynamicValue.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
dynamicValue.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
dynamicValue.pathThe path to the element to be set dynamicallyThe 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 resolveable 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).The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
dynamicValue.expressionAn expression that provides the dynamic value for the customizationAn expression specifying the value of the customized element.The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.