This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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
Clinical Decision Support Work Group | Maturity Level: 2 | Trial Use | Compartments: Not linked to any defined compartments |
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 URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this activity definition is (or will be) published. |
Control | 0..1 |
Type | uri |
Requirements | Allows the activity definition to be referenced by a single globally unique identifier. |
Summary | true |
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 URL SHOULD include the major version of the activity definition. For more information see Technical and Business Versions. |
ActivityDefinition.identifier | |
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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Summary | true |
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this activity definition outside of FHIR, where it is not possible to use the logical URI. |
ActivityDefinition.version | |
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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
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]. |
ActivityDefinition.name | |
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. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation and code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. |
ActivityDefinition.title | |
Definition | A short, descriptive, user-friendly title for the activity definition. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
ActivityDefinition.status | |
Definition | The status of this activity definition. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Allows filtering of activity definitions that are appropriate for use vs. not. |
ActivityDefinition.experimental | |
Definition | A 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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. |
Summary | true |
Comments | Allows filtering of activity definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental activity definition in production. |
ActivityDefinition.date | |
Definition | The date (and optionally time) when the activity definition was published. The date must change if and 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. |
Control | 0..1 |
Type | dateTime |
Alternate Names | Revision Date |
Summary | true |
Comments | 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. |
ActivityDefinition.publisher | |
Definition | The name of the individual or organization that published the activity definition. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact. |
Summary | true |
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. |
ActivityDefinition.description | |
Definition | A free text natural language description of the activity definition from a consumer's perspective. |
Control | 0..1 |
Type | markdown |
Summary | true |
Comments | 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 profile is presumed to be the predominant language in the place the profile was created). |
ActivityDefinition.purpose | |
Definition | Explaination of why this activity definition is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
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. |
ActivityDefinition.usage | |
Definition | A detailed description of how the activity definition is used from a clinical perspective. |
Control | 0..1 |
Type | string |
ActivityDefinition.approvalDate | |
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Control | 0..1 |
Type | date |
Comments | The 'date' element may be more recent than the approval date because of minor changes / editorial corrections. |
ActivityDefinition.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. |
Control | 0..1 |
Type | date |
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. |
Comments | If specified, this is usually after the approval date. |
ActivityDefinition.effectivePeriod | |
Definition | The period during which the activity definition content was or is planned to be in active use. |
Control | 0..1 |
Type | Period |
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the activity definition are or are expected to be used instead. |
Summary | true |
Comments | 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. |
ActivityDefinition.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. |
ActivityDefinition.jurisdiction | |
Definition | A legal or geographic region in which the activity definition is intended to be used. |
Control | 0..* |
Terminology Binding | Jurisdiction ValueSet (Extensible) |
Type | CodeableConcept |
Summary | true |
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. |
ActivityDefinition.topic | |
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. |
Control | 0..* |
Terminology Binding | DefinitionTopic (Example) |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. |
ActivityDefinition.contributor | |
Definition | A contributor to the content of the activity definition, 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.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
ActivityDefinition.copyright | |
Definition | A 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. |
Control | 0..1 |
Type | markdown |
Requirements | Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. |
Alternate Names | License; Restrictions |
ActivityDefinition.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Control | 0..* |
Type | RelatedArtifact |
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. |
Comments | Each related artifact 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 activity definition. |
Control | 0..* |
Type | Reference(Library) |
ActivityDefinition.kind | |
Definition | A 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. |
Control | 0..1 |
Terminology Binding | ResourceType (Required) |
Type | code |
Summary | true |
Comments | 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 |
Terminology Binding | Procedure Codes (SNOMED CT) (Example) |
Type | CodeableConcept |
Requirements | Allows matching performed to planned as well as validation against protocols. |
Summary | true |
Comments | Tends to be less relevant for activities involving particular products. |
ActivityDefinition.doNotPerform | |
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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Summary | true |
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 RequestGroup. |
ActivityDefinition.timing[x] | |
Definition | The period, timing or frequency upon which the described activity is to occur. |
Control | 0..1 |
Type | Timing|dateTime|Age|Period|Range|Duration |
[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.participant | |
Definition | Indicates who should participate in performing the action described. |
Control | 0..* |
ActivityDefinition.participant.type | |
Definition | The type of participant in the action. |
Control | 1..1 |
Terminology Binding | ActionParticipantType (Required) |
Type | code |
ActivityDefinition.participant.role | |
Definition | The role the participant should play in performing the described action. |
Control | 0..1 |
Terminology Binding | ActionParticipantRole (Example) |
Type | CodeableConcept |
ActivityDefinition.product[x] | |
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. |
Control | 0..1 |
Terminology Binding | SNOMED CT Medication Codes (Example) |
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.dosage | |
Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. |
Control | 0..* |
Type | Dosage |
Comments | If a dosage instruction is used, the definition should not specify timing or quantity. |
ActivityDefinition.bodySite | |
Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). |
Control | 0..* |
Terminology Binding | SNOMED CT Body Structures (Example) |
Type | CodeableConcept |
Requirements | Knowing where the procedure is made is important for tracking if multiple sites are possible. |
Comments | Only used if not implicit in the code found in ServiceRequest.type. |
ActivityDefinition.specimenRequirement | |
Definition | Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
Control | 0..* |
Type | Reference(SpecimenDefinition) |
Requirements | Needed to represent lab order definitions. |
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. |