FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Anonymous Compartments: No 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.

Short Display The definition of a specific activity to be taken, independent of any particular patient or context
Cardinality 0..*
Type MetadataResource
Summary false
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,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 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.

Short Display Canonical identifier for this activity definition, represented as a URI (globally unique)
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.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
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.

Short Display Additional identifier for the activity definition
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.

Short Display Business version of the activity definition
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]. The version SHOULD NOT contain a '#' - see Business Version.

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

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

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.

Short Display Name for this activity definition (computer friendly)
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
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ActivityDefinition.title
Element Id ActivityDefinition.title
Definition

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

Short Display Name for this activity definition (human friendly)
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.

Short Display Subordinate title of the activity definition
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.

Short Display draft | active | retired | unknown
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.

See guidance around (not) making local changes to elements here.

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.

Short Display For testing purposes, not real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
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, group 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.

Short Display Type of individual the activity definition is intended for
Cardinality 0..1
Terminology Binding Participant Resource Types (Extensible)
Type CodeableConcept|Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)|canonical(EvidenceVariable)
[x] Note See Choice of Datatypes for further information about how to use [x]
Meaning if Missing Patient
Summary false
Comments

Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

ActivityDefinition.date
Element Id ActivityDefinition.date
Definition

The date (and optionally time) when the activity definition was last significantly changed. 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.

Short Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here.

ActivityDefinition.publisher
Element Id ActivityDefinition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.

Short Display Name of the publisher/steward (organization or individual)
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.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

See guidance around (not) making local changes to elements here.

ActivityDefinition.description
Element Id ActivityDefinition.description
Definition

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

Short Display Natural language description of the activity definition
Cardinality 0..1
Type markdown
Summary true
Comments

This description can be used to capture details such as 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.

Short Display The context that the content is intended to support
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
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id ActivityDefinition.jurisdiction
Definition

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

Short Display Intended jurisdiction for activity definition (if applicable)
Cardinality 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.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

ActivityDefinition.purpose
Element Id ActivityDefinition.purpose
Definition

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

Short Display Why this activity definition is defined
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.

Short Display Describes the clinical usage of the activity definition
Cardinality 0..1
Type markdown
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.

Short Display Use and/or publishing restrictions
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
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

ActivityDefinition.copyrightLabel
Element Id ActivityDefinition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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.

Short Display When the activity definition was approved by publisher
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.

See guidance around (not) making local changes to elements here.

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.

Short Display When the activity definition was last reviewed by the publisher
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.

See guidance around (not) making local changes to elements here.

ActivityDefinition.effectivePeriod
Element Id ActivityDefinition.effectivePeriod
Definition

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

Short Display When the activity definition is expected to be used
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 an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

ActivityDefinition.topic
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
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.

Short Display E.g. Education, Treatment, Assessment, etc
Cardinality 0..*
Terminology Binding Definition Topic (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
Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

ActivityDefinition.author
Element Id ActivityDefinition.author
Definition

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

Short Display Who authored 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.

Short Display Who edited the content
Cardinality 0..*
Type ContactDetail
Summary false
ActivityDefinition.reviewer
Element Id ActivityDefinition.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

Short Display Who reviewed the content
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

ActivityDefinition.endorser
Element Id ActivityDefinition.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

Short Display Who endorsed the content
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

ActivityDefinition.relatedArtifact
Element Id ActivityDefinition.relatedArtifact
Definition

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

Short Display Additional documentation, citations, etc
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.

Short Display 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.

Short Display Kind of resource
Cardinality 0..1
Terminology Binding Request Resource Types (Required)
Type code
Summary true
Comments

The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created 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.

Short Display What profile the resource needs to conform to
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.

Short Display Detail type of activity
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.

Short Display proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
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.

Short Display routine | urgent | asap | stat
Cardinality 0..1
Terminology Binding 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.

Short Display True if the activity should not be performed
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 RequestOrchestration.

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

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

Short Display When activity is to occur
Cardinality 0..1
Type Timing|Age|Range|Duration
[x] Note See Choice of Datatypes 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 RequestOrchestration, 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.asNeeded[x]
Element Id ActivityDefinition.asNeeded[x]
Definition

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

Short Display Preconditions for service
Cardinality 0..1
Terminology Binding SNOMED CT Medication As Needed Reason Codes (Example)
Type boolean|CodeableConcept
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
ActivityDefinition.location
Element Id ActivityDefinition.location
Definition

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

Short Display Where it should happen
Cardinality 0..1
Type 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.

Short Display Who should participate in the action
Cardinality 0..*
Summary false
ActivityDefinition.participant.type
Element Id ActivityDefinition.participant.type
Definition

The type of participant in the action.

Short Display careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Cardinality 0..1
Terminology Binding Action Participant Type (Required)
Type code
Summary false
ActivityDefinition.participant.typeCanonical
Element Id ActivityDefinition.participant.typeCanonical
Definition

The type of participant in the action.

Short Display Who or what can participate
Cardinality 0..1
Type canonical(CapabilityStatement)
Summary false
ActivityDefinition.participant.typeReference
Element Id ActivityDefinition.participant.typeReference
Definition

The type of participant in the action.

Short Display Who or what can participate
Cardinality 0..1
Type Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
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.

Short Display E.g. Nurse, Surgeon, Parent, etc
Cardinality 0..1
Terminology Binding Action Participant Role icon (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.

Short Display E.g. Author, Reviewer, Witness, etc
Cardinality 0..1
Terminology Binding Action Participant Function (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.

Short Display What's administered/supplied
Cardinality 0..1
Terminology Binding SNOMED CT Medication Codes (Example)
Type Reference(Medication | Ingredient | Substance | SubstanceDefinition)|CodeableConcept
[x] Note See Choice of Datatypes 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.).

Short Display How much is administered/consumed/supplied
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.

Short Display Detailed dosage instructions
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).

Short Display What part of body to perform on
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.

Short Display What specimens are required to perform this action
Cardinality 0..*
Type canonical(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.

Short Display What observations are required to perform this action
Cardinality 0..*
Type canonical(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.

Short Display What observations must be produced by this action
Cardinality 0..*
Type canonical(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.

Short Display Transform to apply the template
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.

Short Display Dynamic aspects of the definition
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 resolvable 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).

Short Display The path to the element to be set dynamically
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.

Short Display An expression that provides the dynamic value for the customization
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.