Release 4 5 Draft Ballot
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group Maturity Level : 2 3   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the ActivityDefinition resource.

ActivityDefinition
Element Id ActivityDefinition
Definition

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

Cardinality 0..*
Type DomainResource MetadataResource
Summary false
Invariants
Defined on this element
adf-0 cnl-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ActivityDefinition.url
Element Id 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; 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.

Cardinality 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 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 .

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 element to indicate where the current master source of the resource can be found.

ActivityDefinition.identifier
Element Id 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 identifier, not a resource identifier (see discussion )
Cardinality 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, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.

ActivityDefinition.version
Element Id 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 )
Cardinality 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
Element Id 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.

Cardinality 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 alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0 cnl-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ActivityDefinition.title
Element Id ActivityDefinition.title
Definition

A short, descriptive, user-friendly title for the activity definition.

Cardinality 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.subtitle
Element Id ActivityDefinition.subtitle
Definition

An explanatory or alternate title for the activity definition giving additional information about its content.

Cardinality 0..1
Type string
Summary false
ActivityDefinition.status
Element Id ActivityDefinition.status
Definition

The status of this activity definition. Enables tracking the life-cycle of the content.

Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

Allows filtering of activity definitions that are appropriate for use versus not.

ActivityDefinition.experimental
Element Id 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.

Cardinality 0..1
Type boolean
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 definitions that are appropriate for use versus not.

ActivityDefinition.subject[x]
Element Id ActivityDefinition.subject[x]
Definition

A code or code, group definition definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

Cardinality 0..1
Terminology Binding Subject type ( Extensible )
Type CodeableConcept | Reference ( Group ) )| canonical
[x] Note See Choice of Data Types for further information about how to use [x]
Meaning if Missing Patient
Summary false
ActivityDefinition.date
Element Id ActivityDefinition.date
Definition

The 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.

Cardinality 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
Element Id ActivityDefinition.publisher
Definition

The name of the organization or individual that published the activity definition.

Cardinality 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.contact
Element Id ActivityDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

ActivityDefinition.description
Element Id ActivityDefinition.description
Definition

A free text natural language description of the activity definition from a consumer's perspective.

Cardinality 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 activity definition is presumed to be the predominant language in the place the activity definition was created).

ActivityDefinition.useContext
Element Id ActivityDefinition.useContext
Definition

The 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.

Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

ActivityDefinition.jurisdiction
Element Id ActivityDefinition.jurisdiction
Definition

A legal or geographic region in which the activity definition is intended to be used.

Cardinality 0..*
Terminology Binding Jurisdiction ( 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.purpose
Element Id ActivityDefinition.purpose
Definition

Explanation of why this activity definition is needed and why it has been designed as it has.

Cardinality 0..1
Type markdown
Summary false
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
Element Id ActivityDefinition.usage
Definition

A detailed description of how the activity definition is used from a clinical perspective.

Cardinality 0..1
Type string
Summary false
ActivityDefinition.copyright
Element Id 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.

Cardinality 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
Summary false
ActivityDefinition.approvalDate
Element Id 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.

Cardinality 0..1
Type date
Summary false
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

ActivityDefinition.lastReviewDate
Element Id ActivityDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Cardinality 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.

Summary false
Comments

If specified, this date follows the original approval date.

ActivityDefinition.effectivePeriod
Element Id ActivityDefinition.effectivePeriod
Definition

The period during which the activity definition content was or is planned to be in active use.

Cardinality 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 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.topic
Element Id 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.

Cardinality 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.

Summary false
ActivityDefinition.author
Element Id ActivityDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Cardinality 0..*
Type ContactDetail
Summary false
ActivityDefinition.editor
Element Id ActivityDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Cardinality 0..*
Type ContactDetail
Summary false
ActivityDefinition.reviewer
Element Id ActivityDefinition.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

Cardinality 0..*
Type ContactDetail
Summary false
ActivityDefinition.endorser
Element Id ActivityDefinition.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Cardinality 0..*
Type ContactDetail
Summary false
ActivityDefinition.relatedArtifact
Element Id ActivityDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Cardinality 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.

Summary false
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

ActivityDefinition.library
Element Id ActivityDefinition.library
Definition

A reference to a Library resource containing any formal logic used by the activity definition.

Cardinality 0..*
Type canonical ( Library )
Summary false
ActivityDefinition.kind
Element Id 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.

Cardinality 0..1
Terminology Binding RequestResourceType ( Required )
Type code
Summary true
Comments

May determine what types of extensions are permitted.

ActivityDefinition.profile
Element Id ActivityDefinition.profile
Definition

A profile to which the target of the activity definition is expected to conform.

Cardinality 0..1
Type canonical ( StructureDefinition )
Requirements

Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.

Summary false
ActivityDefinition.code
Element Id ActivityDefinition.code
Definition

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

Cardinality 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.intent
Element Id ActivityDefinition.intent
Definition

Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

Cardinality 0..1
Terminology Binding RequestIntent ( Required )
Type code
Summary false
ActivityDefinition.priority
Element Id ActivityDefinition.priority
Definition

Indicates how quickly the activity should be addressed with respect to other requests.

Cardinality 0..1
Terminology Binding Request priority RequestPriority ( Required )
Type code
Summary false
ActivityDefinition.doNotPerform
Element Id 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.

Cardinality 0..1
Type boolean
Is Modifier true (Reason: If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.)
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]
Element Id ActivityDefinition.timing[x]
Definition

The period, timing or frequency upon which the described activity is to occur.

Cardinality 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.

Summary false
Comments

The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestGroup, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

ActivityDefinition.location
Element Id ActivityDefinition.location
Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Cardinality 0..1
Type Reference CodeableReference ( Location )
Requirements

Helps in planning of activity.

Alternate Names facility
Summary false
Comments

May reference a specific clinical location or may just identify a type of location.

ActivityDefinition.participant
Element Id ActivityDefinition.participant
Definition

Indicates who should participate in performing the action described.

Cardinality 0..*
Summary false
ActivityDefinition.participant.type
Element Id ActivityDefinition.participant.type
Definition

The type of participant in the action.

Cardinality 1..1 0..1
Terminology Binding ActionParticipantType ( Required )
Type code
Summary false
ActivityDefinition.participant.typeReference
Element Id ActivityDefinition.participant.typeReference
Definition

The type of participant in the action.

Cardinality 0..1
Type Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )
Patterns Reference(CareTeam,Device,Group,HealthcareService,Location,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson): Common patterns = Participant
Summary false
Comments

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

ActivityDefinition.participant.role
Element Id ActivityDefinition.participant.role
Definition

The role the participant should play in performing the described action.

Cardinality 0..1
Terminology Binding Action participant role ActionParticipantRole ( Example )
Type CodeableConcept
Summary false
ActivityDefinition.participant.function
Element Id ActivityDefinition.participant.function
Definition

Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

Cardinality 0..1
Terminology Binding ActionParticipantFunction ( Example )
Type CodeableConcept
Summary false
ActivityDefinition.product[x]
Element Id ActivityDefinition.product[x]
Definition

Identifies the food, drug or other product being consumed or supplied in the activity.

Cardinality 0..1
Terminology Binding SNOMED CT Medication Codes ( Example )
Type Reference ( Medication | Substance | Ingredient )| CodeableConcept
Patterns Reference(Medication,Substance,Ingredient): No common pattern
[x] Note See Choice of Data Types for further information about how to use [x]
Summary false
ActivityDefinition.quantity
Element Id ActivityDefinition.quantity
Definition

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

Cardinality 0..1
Type SimpleQuantity
Alternate Names dose
Summary false
ActivityDefinition.dosage
Element Id ActivityDefinition.dosage
Definition

Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

Cardinality 0..*
Type Dosage
Summary false
Comments

If a dosage instruction is used, the definition should not specify timing or quantity.

ActivityDefinition.bodySite
Element Id ActivityDefinition.bodySite
Definition

Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

Cardinality 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.

Summary false
Comments

Only used if not implicit in the code found in ServiceRequest.type.

ActivityDefinition.specimenRequirement
Element Id ActivityDefinition.specimenRequirement
Definition

Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

Cardinality 0..*
Type Reference ( SpecimenDefinition )
Requirements

Needed to represent lab order definitions.

Summary false
ActivityDefinition.observationRequirement
Element Id ActivityDefinition.observationRequirement
Definition

Defines observation requirements for the action to be performed, such as body weight or surface area.

Cardinality 0..*
Type Reference ( ObservationDefinition )
Requirements

Needed to represent observation definitions.

Summary false
ActivityDefinition.observationResultRequirement
Element Id ActivityDefinition.observationResultRequirement
Definition

Defines the observations that are expected to be produced by the action.

Cardinality 0..*
Type Reference ( ObservationDefinition )
Summary false
ActivityDefinition.transform
Element Id 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.

Cardinality 0..1
Type canonical ( StructureMap )
Summary false
Comments

Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

ActivityDefinition.dynamicValue
Element Id 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 request resource that would contain the result.

Cardinality 0..*
Summary false
Comments

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.

ActivityDefinition.dynamicValue.path
Element Id 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. 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 for full details).

Cardinality 1..1
Type string
Summary false
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

ActivityDefinition.dynamicValue.expression
Element Id ActivityDefinition.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Cardinality 1..1
Type Expression
Summary false
Comments

The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.