FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 GroupMaturity Level: 2 Trial UseCompartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ActivityDefinition resource.

ActivityDefinition
Definition

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

Control1..1
ActivityDefinition.url
Definition

An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see Technical and Business Versions.

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

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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
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, e.g., to identify this activity definition outside of FHIR, where it is not possible to use the logical URI.

ActivityDefinition.version
Definition

The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..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 refrence to a particular business version of the activity definition with the format [url]|[version].

ActivityDefinition.name
Definition

A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..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 alpha-numeric type name to ensure that it is computable friendly.

ActivityDefinition.title
Definition

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

Control0..1
Typestring
Summarytrue
Comments

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

ActivityDefinition.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of activity definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired activity definition without due consideration.

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.

Control0..1
Typeboolean
Is Modifiertrue
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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental activity definition in production.

ActivityDefinition.date
Definition

The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ActivityDefinition.publisher
Definition

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

Control0..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.description
Definition

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

Control0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).

ActivityDefinition.purpose
Definition

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

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the activity definition Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.

ActivityDefinition.usage
Definition

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

Control0..1
Typestring
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.

Control0..1
Typedate
Comments

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

ActivityDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

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

Comments

If specified, this is usually after the approval date.

ActivityDefinition.effectivePeriod
Definition

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

Control0..1
TypePeriod
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.

Summarytrue
Comments

The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

ActivityDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ActivityDefinition.jurisdiction
Definition

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

Control0..*
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.

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.

Control0..*
Terminology BindingDefinitionTopic (Example)
TypeCodeableConcept
Requirements

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

ActivityDefinition.contributor
Definition

A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.

Control0..*
TypeContributor
Requirements

Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset.

ActivityDefinition.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

ActivityDefinition.copyright
Definition

A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

Control0..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
ActivityDefinition.relatedArtifact
Definition

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

Control0..*
TypeRelatedArtifact
Requirements

Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

ActivityDefinition.library
Definition

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

Control0..*
TypeReference(Library)
ActivityDefinition.kind
Definition

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

Control0..1
Terminology BindingResourceType (Required)
Typecode
Comments

May determine what types of extensions are permitted.

ActivityDefinition.code
Definition

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

Control0..1
Terminology BindingProcedure Codes (SNOMED CT) (Example)
TypeCodeableConcept
Requirements

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

Comments

Tends to be less relevant for activities involving particular products.

ActivityDefinition.timing[x]
Definition

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

Control0..1
TypeTiming|dateTime|Period|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Allows prompting for activities and detection of missed planned activities.

ActivityDefinition.location
Definition

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

Control0..1
TypeReference(Location)
Requirements

Helps in planning of activity.

Alternate Namesfacility
Comments

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

ActivityDefinition.participant
Definition

Indicates who should participate in performing the action described.

Control0..*
ActivityDefinition.participant.type
Definition

The type of participant in the action.

Control1..1
Terminology BindingActionParticipantType (Required)
Typecode
ActivityDefinition.participant.role
Definition

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

Control0..1
Terminology BindingActionParticipantRole (Example)
TypeCodeableConcept
ActivityDefinition.product[x]
Definition

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

Control0..1
Terminology BindingSNOMED CT Medication Codes (Example)
TypeReference(Medication | Substance)|CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
ActivityDefinition.quantity
Definition

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

Control0..1
TypeSimpleQuantity
Alternate Namesdose
ActivityDefinition.dosage
Definition

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

Control0..*
TypeDosage
Comments

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

ActivityDefinition.bodySite
Definition

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

Control0..*
Terminology BindingSNOMED CT Body Structures (Example)
TypeCodeableConcept
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 ProcedureRequest.type.

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.

Control0..1
TypeReference(StructureMap)
ActivityDefinition.dynamicValue
Definition

Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.

Control0..*
ActivityDefinition.dynamicValue.description
Definition

A brief, natural language description of the intended semantics of the dynamic value.

Control0..1
Typestring
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.

Control0..1
Typestring
ActivityDefinition.dynamicValue.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
ActivityDefinition.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Control0..1
Typestring
Comments

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