This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.3.0:
R4
Ballot
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Clinical
Decision
Support
Work
Group
|
Maturity Level : 2 | Trial Use | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the ActivityDefinition resource.
| ActivityDefinition | |
| 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. |
| Control | 1..1 |
| 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
|
| Control | 0..1 |
| Type | uri |
| Requirements |
Allows the activity definition to be referenced by a single globally unique identifier. |
| Summary | true |
| Comments |
Can
be
a
urn:uuid:
or
a
The URL SHOULD include the major version of the activity definition. For more information see Technical and Business Versions . |
| 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 identifer, not a resource identifier (see discussion ) |
| Control | 0..* |
| Type | Identifier |
| Requirements |
Allows externally provided and/or usable business identifiers to be easily associated with the module. |
| Summary | true |
| Comments |
Typically,
this
is
used
for
identifiers
that
can
go
in
an
HL7
V3
II
(instance
identifier)
data
type,
|
| 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 ) |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
There
may
be
different
activity
definition
instances
that
have
the
same
identifier
but
different
versions.
The
version
can
be
appended
to
the
url
in
a
reference
to
allow
a
|
| 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. |
| Control | 0..1 |
| Type | string |
| Requirements |
Support human navigation and code generation. |
| Summary | true |
| Comments |
The
name
is
not
expected
to
be
globally
unique.
The
name
should
be
a
simple
|
| ActivityDefinition.title | |
| Element Id | ActivityDefinition.title |
| Definition |
A short, descriptive, user-friendly title for the activity definition. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
| ActivityDefinition.subtitle | |
| Element Id | ActivityDefinition.subtitle |
| Definition | An explanatory or alternate title for the activity definition giving additional information about its content. |
| Control | 0..1 |
| Type | string |
| ActivityDefinition.status | |
| Element Id | ActivityDefinition.status |
| Definition |
The status of this activity definition. Enables tracking the life-cycle of the content. |
| Control | 1..1 |
| Terminology Binding | PublicationStatus ( Required ) |
| Type | code |
| Is Modifier | true (Reason: null) |
| Summary | true |
| Comments |
Allows
filtering
of
activity
definitions
that
are
appropriate
for
use
|
| ActivityDefinition.experimental | |
| Element Id | ActivityDefinition.experimental |
| Definition |
A
|
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true (Reason: null) |
| 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
|
| ActivityDefinition.subject[x] | |
| Element Id | ActivityDefinition.subject[x] |
| Definition |
A
code
or
group
definition
|
| Control | 0..1 |
| Terminology Binding | SubjectType ( Extensible ) |
| Type | CodeableConcept | Reference ( Group ) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Meaning if Missing | Patient |
| ActivityDefinition.date | |
| Element Id | ActivityDefinition.date |
| Definition |
The
date
(and
optionally
time)
when
the
activity
definition
was
published.
The
date
must
change
|
| Control | 0..1 |
| Type | dateTime |
| Alternate Names | Revision Date |
| Summary | true |
| Comments |
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
| ActivityDefinition.publisher | |
| Element Id | ActivityDefinition.publisher |
| Definition |
The
name
of
the
|
| Control | 0..1 |
| Type | string |
| Requirements |
Helps
establish
the
|
| Summary | true |
| Comments |
Usually
an
|
| ActivityDefinition.contact | |
| Element Id | ActivityDefinition.contact |
| Definition | Contact details to assist a user in finding and communicating with the publisher. |
| Control | 0..* |
| Type | ContactDetail |
| Summary | true |
| Comments | May be a web site, an email address, a telephone number, etc. |
| ActivityDefinition.description | |
| Element Id | ActivityDefinition.description |
| Definition |
A free text natural language description of the activity definition from a consumer's perspective. |
| Control | 0..1 |
| Type | markdown |
| Summary | true |
| Comments |
This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). |
| ActivityDefinition.useContext | |
| Element Id | ActivityDefinition.useContext |
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances. |
| Control | 0..* |
| Type | UsageContext |
| Requirements | Assist in searching for appropriate content. |
| Summary | true |
| Comments | When multiple useContexts are specified, there is no expectation 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. |
| Control | 0..* |
| Terminology Binding | Jurisdiction ValueSet ( Extensible ) |
| Type | CodeableConcept |
| Summary | true |
| Comments | It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. |
| ActivityDefinition.purpose | |
| Element Id | ActivityDefinition.purpose |
| Definition |
|
| Control | 0..1 |
| Type | markdown |
| Comments |
This
element
does
not
describe
the
usage
of
the
activity
|
| ActivityDefinition.usage | |
| Element Id | ActivityDefinition.usage |
| Definition |
A
detailed
description
of
how
the
|
| Control | 0..1 |
| Type | string |
| 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. |
| Control | 0..1 |
| Type | markdown |
| Requirements | Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. |
| Alternate Names | License; Restrictions |
| ActivityDefinition.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. |
| Control | 0..1 |
| Type | date |
| Comments |
The
'date'
element
may
be
more
recent
than
the
approval
date
because
of
minor
changes
|
| ActivityDefinition.lastReviewDate | |
| Element Id | ActivityDefinition.lastReviewDate |
| Definition |
The
date
on
which
the
resource
content
was
last
reviewed.
Review
happens
periodically
after
|
| Control | 0..1 |
| Type | date |
| Requirements |
Gives
a
sense
of
how
|
| Comments |
If
specified,
this
|
| ActivityDefinition.effectivePeriod | |
| Element Id | ActivityDefinition.effectivePeriod |
| Definition |
The period during which the activity definition content was or is planned to be in active use. |
| Control | 0..1 |
| Type | Period |
| Requirements |
Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the activity definition are or are expected to be used instead. |
| Summary | true |
| Comments |
The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
|
|
|
|
|
|
| Definition |
Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. |
| Control | 0..* |
| Terminology Binding | DefinitionTopic ( Example ) |
| Type | CodeableConcept |
| Requirements |
Repositories
must
be
able
to
determine
how
to
categorize
the
|
| ActivityDefinition.contributor | |
| Element Id | ActivityDefinition.contributor |
| Definition |
A
contributor
to
the
content
of
the
|
| Control | 0..* |
| Type | Contributor |
| Requirements |
Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset. |
|
|
|
|
|
|
| Definition |
Related artifacts such as additional documentation, justification, or bibliographic references. |
| Control | 0..* |
| Type | RelatedArtifact |
| Requirements |
|
| 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
|
| Control | 0..* |
| Type |
|
| ActivityDefinition.kind | |
| Element Id | ActivityDefinition.kind |
| Definition |
A
description
of
the
kind
of
resource
the
activity
definition
is
representing.
For
example,
a
MedicationRequest,
a
|
| Control | 0..1 |
| Terminology Binding | ResourceType ( Required ) |
| Type | code |
| Summary | true |
| Comments |
May determine what types of extensions are permitted. |
| 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. |
| Control | 0..1 |
| Terminology Binding | Procedure Codes (SNOMED CT) ( Example ) |
| Type | CodeableConcept |
| Requirements |
Allows matching performed to planned as well as validation against protocols. |
| Summary | true |
| Comments |
Tends to be less relevant for activities involving particular products. |
| ActivityDefinition.doNotPerform | |
| 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. |
| Control | 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. |
| Control | 0..1 |
| Type | Timing | dateTime | Age | Period | Range | Duration |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Requirements |
Allows prompting for activities and detection of missed planned activities. |
| ActivityDefinition.location | |
| Element Id | ActivityDefinition.location |
| Definition |
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
| Control | 0..1 |
| Type | Reference ( Location ) |
| Requirements |
Helps in planning of activity. |
| Alternate Names | facility |
| Comments |
May reference a specific clinical location or may just identify a type of location. |
| ActivityDefinition.participant | |
| Element Id | ActivityDefinition.participant |
| Definition |
Indicates who should participate in performing the action described. |
| Control | 0..* |
| ActivityDefinition.participant.type | |
| Element Id | ActivityDefinition.participant.type |
| Definition |
The type of participant in the action. |
| Control | 1..1 |
| Terminology Binding | ActionParticipantType ( Required ) |
| Type | code |
| ActivityDefinition.participant.role | |
| Element Id | ActivityDefinition.participant.role |
| Definition |
The role the participant should play in performing the described action. |
| Control | 0..1 |
| Terminology Binding | ActionParticipantRole ( Example ) |
| Type | CodeableConcept |
| ActivityDefinition.product[x] | |
| Element Id | ActivityDefinition.product[x] |
| Definition |
Identifies the food, drug or other product being consumed or supplied in the activity. |
| Control | 0..1 |
| Terminology Binding | SNOMED CT Medication Codes ( Example ) |
| Type | Reference ( Medication | Substance )| CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| ActivityDefinition.quantity | |
| Element Id | ActivityDefinition.quantity |
| Definition |
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
| Control | 0..1 |
| Type | SimpleQuantity |
| Alternate Names | dose |
| ActivityDefinition.dosage | |
| Element Id | ActivityDefinition.dosage |
| Definition |
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. |
| Control | 0..* |
| Type | Dosage |
| Comments |
If a dosage instruction is used, the definition should not specify timing or quantity. |
| ActivityDefinition.bodySite | |
| Element Id | ActivityDefinition.bodySite |
| Definition |
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). |
| Control | 0..* |
| Terminology Binding | SNOMED CT Body Structures ( Example ) |
| Type | CodeableConcept |
| Requirements |
Knowing where the procedure is made is important for tracking if multiple sites are possible. |
| Comments |
Only
used
if
not
implicit
in
the
code
found
in
|
| ActivityDefinition.specimenRequirement | |
| Element Id | ActivityDefinition.specimenRequirement |
| Definition | Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
| Control | 0..* |
| Type | Reference ( SpecimenDefinition ) |
| Requirements | Needed to represent lab order definitions. |
| ActivityDefinition.transform | |
| 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. |
| Control | 0..1 |
| Type |
|
| 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
|
| Control | 0..* |
| 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.description | |
| Element Id | ActivityDefinition.dynamicValue.description |
| Definition |
A brief, natural language description of the intended semantics of the dynamic value. |
| Control | 0..1 |
| Type | string |
| ActivityDefinition.dynamicValue.path | |
| 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. |
| Control | 0..1 |
| Type | string |
| ActivityDefinition.dynamicValue.language | |
| Element Id | ActivityDefinition.dynamicValue.language |
| Definition |
The media type of the language for the expression. |
| Control | 0..1 |
| Type | string |
| ActivityDefinition.dynamicValue.expression | |
| Element Id | ActivityDefinition.dynamicValue.expression |
| Definition |
An expression specifying the value of the customized element. |
| Control | 0..1 |
| Type | string |
| Comments |
The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |