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 IdActivityDefinition
Definition

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

Short DisplayThe definition of a specific activity to be taken, independent of any particular patient or context
Cardinality0..*
TypeMetadataResource
Summaryfalse
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 IdActivityDefinition.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 DisplayCanonical identifier for this activity definition, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the activity definition to be referenced by a single globally unique identifier.

Summarytrue
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 IdActivityDefinition.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 DisplayAdditional identifier for the activity definition
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
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 IdActivityDefinition.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 DisplayBusiness version of the activity definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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 IdActivityDefinition.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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 IdActivityDefinition.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 DisplayName for this activity definition (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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 IdActivityDefinition.title
Definition

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

Short DisplayName for this activity definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ActivityDefinition.subtitle
Element IdActivityDefinition.subtitle
Definition

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

Short DisplaySubordinate title of the activity definition
Cardinality0..1
Typestring
Summaryfalse
ActivityDefinition.status
Element IdActivityDefinition.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
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 IdActivityDefinition.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 DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf 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.

Summarytrue
Comments

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

ActivityDefinition.subject[x]
Element IdActivityDefinition.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 DisplayType of individual the activity definition is intended for
Cardinality0..1
Terminology BindingParticipant Resource Types (Extensible)
TypeCodeableConcept|Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)|canonical(EvidenceVariable)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Meaning if MissingPatient
Summaryfalse
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 IdActivityDefinition.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 DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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 IdActivityDefinition.publisher
Definition

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

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the activity definition. May also allow for contact.

Summarytrue
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 IdActivityDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
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 IdActivityDefinition.description
Definition

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

Short DisplayNatural language description of the activity definition
Cardinality0..1
Typemarkdown
Summarytrue
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 IdActivityDefinition.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 DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ActivityDefinition.jurisdiction
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdActivityDefinition.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for activity definition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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 IdActivityDefinition.purpose
Definition

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

Short DisplayWhy this activity definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdActivityDefinition.usage
Definition

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

Short DisplayDescribes the clinical usage of the activity definition
Cardinality0..1
Typemarkdown
Summaryfalse
ActivityDefinition.copyright
Element IdActivityDefinition.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 DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

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

ActivityDefinition.copyrightLabel
Element IdActivityDefinition.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 DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
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 IdActivityDefinition.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 DisplayWhen the activity definition was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
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 IdActivityDefinition.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 DisplayWhen the activity definition was last reviewed by the publisher
Cardinality0..1
Typedate
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.

Summaryfalse
Comments

If specified, this date follows the original approval date.

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

ActivityDefinition.effectivePeriod
Element IdActivityDefinition.effectivePeriod
Definition

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

Short DisplayWhen the activity definition is expected to be used
Cardinality0..1
TypePeriod
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.

Summarytrue
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 StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdActivityDefinition.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 DisplayE.g. Education, Treatment, Assessment, etc
Cardinality0..*
Terminology BindingDefinition Topic (Example)
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.

Summaryfalse
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 IdActivityDefinition.author
Definition

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

Short DisplayWho authored the content
Cardinality0..*
TypeContactDetail
Summaryfalse
ActivityDefinition.editor
Element IdActivityDefinition.editor
Definition

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

Short DisplayWho edited the content
Cardinality0..*
TypeContactDetail
Summaryfalse
ActivityDefinition.reviewer
Element IdActivityDefinition.reviewer
Definition

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

Short DisplayWho reviewed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

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

ActivityDefinition.endorser
Element IdActivityDefinition.endorser
Definition

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

Short DisplayWho endorsed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

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

ActivityDefinition.relatedArtifact
Element IdActivityDefinition.relatedArtifact
Definition

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

Short DisplayAdditional documentation, citations, etc
Cardinality0..*
TypeRelatedArtifact
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.

Summaryfalse
Comments

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

ActivityDefinition.library
Element IdActivityDefinition.library
Definition

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

Short DisplayLogic used by the activity definition
Cardinality0..*
Typecanonical(Library)
Summaryfalse
ActivityDefinition.kind
Element IdActivityDefinition.kind
Definition

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

Short DisplayKind of resource
Cardinality0..1
Terminology BindingRequest Resource Types (Required)
Typecode
Summarytrue
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 IdActivityDefinition.profile
Definition

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

Short DisplayWhat profile the resource needs to conform to
Cardinality0..1
Typecanonical(StructureDefinition)
Requirements

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

Summaryfalse
ActivityDefinition.code
Element IdActivityDefinition.code
Definition

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

Short DisplayDetail type of activity
Cardinality0..1
Terminology BindingProcedure Codes (SNOMED CT) (Example)
TypeCodeableConcept
Requirements

Allows matching performed to planned as well as validation against protocols.

Summarytrue
Comments

Tends to be less relevant for activities involving particular products.

ActivityDefinition.intent
Element IdActivityDefinition.intent
Definition

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

Short Displayproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Cardinality0..1
Terminology BindingRequestIntent (Required)
Typecode
Summaryfalse
ActivityDefinition.priority
Element IdActivityDefinition.priority
Definition

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

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Summaryfalse
ActivityDefinition.doNotPerform
Element IdActivityDefinition.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 DisplayTrue if the activity should not be performed
Cardinality0..1
Typeboolean
Is Modifiertrue (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.)
Summarytrue
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 IdActivityDefinition.timing[x]
Definition

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

Short DisplayWhen activity is to occur
Cardinality0..1
TypeTiming|Age|Range|Duration
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Allows prompting for activities and detection of missed planned activities.

Summaryfalse
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 IdActivityDefinition.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 DisplayPreconditions for service
Cardinality0..1
Terminology BindingSNOMED CT Medication As Needed Reason Codes (Example)
Typeboolean|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
ActivityDefinition.location
Element IdActivityDefinition.location
Definition

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

Short DisplayWhere it should happen
Cardinality0..1
TypeCodeableReference(Location)
Requirements

Helps in planning of activity.

Alternate Namesfacility
Summaryfalse
Comments

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

ActivityDefinition.participant
Element IdActivityDefinition.participant
Definition

Indicates who should participate in performing the action described.

Short DisplayWho should participate in the action
Cardinality0..*
Summaryfalse
ActivityDefinition.participant.type
Element IdActivityDefinition.participant.type
Definition

The type of participant in the action.

Short Displaycareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Cardinality0..1
Terminology BindingAction Participant Type (Required)
Typecode
Summaryfalse
ActivityDefinition.participant.typeCanonical
Element IdActivityDefinition.participant.typeCanonical
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
Typecanonical(CapabilityStatement)
Summaryfalse
ActivityDefinition.participant.typeReference
Element IdActivityDefinition.participant.typeReference
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
TypeReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summaryfalse
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 IdActivityDefinition.participant.role
Definition

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

Short DisplayE.g. Nurse, Surgeon, Parent, etc
Cardinality0..1
Terminology BindingAction Participant Role icon (Example)
TypeCodeableConcept
Summaryfalse
ActivityDefinition.participant.function
Element IdActivityDefinition.participant.function
Definition

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

Short DisplayE.g. Author, Reviewer, Witness, etc
Cardinality0..1
Terminology BindingAction Participant Function (Example)
TypeCodeableConcept
Summaryfalse
ActivityDefinition.product[x]
Element IdActivityDefinition.product[x]
Definition

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

Short DisplayWhat's administered/supplied
Cardinality0..1
Terminology BindingSNOMED CT Medication Codes (Example)
TypeReference(Medication | Ingredient | Substance | SubstanceDefinition)|CodeableConcept
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
ActivityDefinition.quantity
Element IdActivityDefinition.quantity
Definition

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

Short DisplayHow much is administered/consumed/supplied
Cardinality0..1
TypeSimpleQuantity
Alternate Namesdose
Summaryfalse
ActivityDefinition.dosage
Element IdActivityDefinition.dosage
Definition

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

Short DisplayDetailed dosage instructions
Cardinality0..*
TypeDosage
Summaryfalse
Comments

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

ActivityDefinition.bodySite
Element IdActivityDefinition.bodySite
Definition

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

Short DisplayWhat part of body to perform on
Cardinality0..*
Terminology BindingSNOMED CT Body Structures (Example)
TypeCodeableConcept
Requirements

Knowing where the procedure is made is important for tracking if multiple sites are possible.

Summaryfalse
Comments

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

ActivityDefinition.specimenRequirement
Element IdActivityDefinition.specimenRequirement
Definition

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

Short DisplayWhat specimens are required to perform this action
Cardinality0..*
Typecanonical(SpecimenDefinition)
Requirements

Needed to represent lab order definitions.

Summaryfalse
ActivityDefinition.observationRequirement
Element IdActivityDefinition.observationRequirement
Definition

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

Short DisplayWhat observations are required to perform this action
Cardinality0..*
Typecanonical(ObservationDefinition)
Requirements

Needed to represent observation definitions.

Summaryfalse
ActivityDefinition.observationResultRequirement
Element IdActivityDefinition.observationResultRequirement
Definition

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

Short DisplayWhat observations must be produced by this action
Cardinality0..*
Typecanonical(ObservationDefinition)
Summaryfalse
ActivityDefinition.transform
Element IdActivityDefinition.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 DisplayTransform to apply the template
Cardinality0..1
Typecanonical(StructureMap)
Summaryfalse
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 IdActivityDefinition.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 DisplayDynamic aspects of the definition
Cardinality0..*
Summaryfalse
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 IdActivityDefinition.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 DisplayThe path to the element to be set dynamically
Cardinality1..1
Typestring
Summaryfalse
Comments

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

ActivityDefinition.dynamicValue.expression
Element IdActivityDefinition.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Short DisplayAn expression that provides the dynamic value for the customization
Cardinality1..1
TypeExpression
Summaryfalse
Comments

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