Skip to main content

ActivityDefinition

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. If the element is present, it must have either a @value, an @id, or extensions

type ActivityDefinition implements Resource {
  url: Uri
  identifier: [Identifier]
  version: String
  name: String
  title: String
  subtitle: String
  status: String
  experimental: Boolean
  subjectCodeableConcept: CodeableConcept
  subjectReference: Reference
  subjectCanonical: Uri
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  purpose: String
  usage: String
  copyright: String
  approvalDate: Date
  lastReviewDate: Date
  effectivePeriod: Period
  topic: [CodeableConcept]
  author: [ContactDetail]
  editor: [ContactDetail]
  reviewer: [ContactDetail]
  endorser: [ContactDetail]
  relatedArtifact: [RelatedArtifact]
  library: [Uri]
  kind: String
  profile: Uri
  code: CodeableConcept
  intent: String
  priority: String
  doNotPerform: Boolean
  timingTiming: Timing
  timingDateTime: Date
  timingAge: Age
  timingPeriod: Period
  timingRange: Range
  timingDuration: Duration
  location: Reference
  participant: [ActivityDefinitionParticipant]
  productReference: Reference
  productCodeableConcept: CodeableConcept
  quantity: Quantity
  dosage: [Dosage]
  bodySite: [CodeableConcept]
  specimenRequirement: [Reference]
  observationRequirement: [Reference]
  observationResultRequirement: [Reference]
  transform: Uri
  dynamicValue: [ActivityDefinitionDynamicValue]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

ActivityDefinition.url ● Uri scalar​

An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.

ActivityDefinition.identifier ● [Identifier] list object​

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.

ActivityDefinition.version ● String scalar​

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.

ActivityDefinition.name ● String scalar​

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.

ActivityDefinition.title ● String scalar​

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

ActivityDefinition.subtitle ● String scalar​

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

ActivityDefinition.status ● String scalar​

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

ActivityDefinition.experimental ● Boolean scalar​

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.

ActivityDefinition.subjectCodeableConcept ● CodeableConcept object​

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. (choose any one of subject*, but only one)

ActivityDefinition.subjectReference ● Reference object​

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. (choose any one of subject*, but only one)

ActivityDefinition.subjectCanonical ● Uri scalar​

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. (choose any one of subject*, but only one)

ActivityDefinition.date ● Date scalar​

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

ActivityDefinition.publisher ● String scalar​

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

ActivityDefinition.contact ● [ContactDetail] list object​

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

ActivityDefinition.description ● String scalar​

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

ActivityDefinition.useContext ● [UsageContext] list object​

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.

ActivityDefinition.jurisdiction ● [CodeableConcept] list object​

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

ActivityDefinition.purpose ● String scalar​

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

ActivityDefinition.usage ● String scalar​

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

ActivityDefinition.copyright ● String scalar​

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.

ActivityDefinition.approvalDate ● Date scalar​

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ActivityDefinition.lastReviewDate ● Date scalar​

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

ActivityDefinition.effectivePeriod ● Period object​

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

ActivityDefinition.topic ● [CodeableConcept] list object​

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.

ActivityDefinition.author ● [ContactDetail] list object​

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

ActivityDefinition.editor ● [ContactDetail] list object​

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

ActivityDefinition.reviewer ● [ContactDetail] list object​

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

ActivityDefinition.endorser ● [ContactDetail] list object​

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

ActivityDefinition.relatedArtifact ● [RelatedArtifact] list object​

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

ActivityDefinition.library ● [Uri] list scalar​

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

ActivityDefinition.kind ● String scalar​

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

ActivityDefinition.profile ● Uri scalar​

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

ActivityDefinition.code ● CodeableConcept object​

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

ActivityDefinition.intent ● String scalar​

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

ActivityDefinition.priority ● String scalar​

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

ActivityDefinition.doNotPerform ● Boolean scalar​

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.

ActivityDefinition.timingTiming ● Timing object​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.timingDateTime ● Date scalar​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.timingAge ● Age object​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.timingPeriod ● Period object​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.timingRange ● Range object​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.timingDuration ● Duration object​

The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)

ActivityDefinition.location ● Reference object​

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

ActivityDefinition.participant ● [ActivityDefinitionParticipant] list object​

Indicates who should participate in performing the action described.

ActivityDefinition.productReference ● Reference object​

Identifies the food, drug or other product being consumed or supplied in the activity. (choose any one of product*, but only one)

ActivityDefinition.productCodeableConcept ● CodeableConcept object​

Identifies the food, drug or other product being consumed or supplied in the activity. (choose any one of product*, but only one)

ActivityDefinition.quantity ● Quantity object​

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

ActivityDefinition.dosage ● [Dosage] list object​

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

ActivityDefinition.bodySite ● [CodeableConcept] list object​

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

ActivityDefinition.specimenRequirement ● [Reference] list object​

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

ActivityDefinition.observationRequirement ● [Reference] list object​

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

ActivityDefinition.observationResultRequirement ● [Reference] list object​

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

ActivityDefinition.transform ● Uri scalar​

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.

ActivityDefinition.dynamicValue ● [ActivityDefinitionDynamicValue] list object​

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.

ActivityDefinition.text ● Narrative object​

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ActivityDefinition.contained ● [Resource] list interface​

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ActivityDefinition.extension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ActivityDefinition.modifierExtension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ActivityDefinition.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ActivityDefinition.meta ● Meta object​

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ActivityDefinition.implicitRules ● Uri scalar​

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ActivityDefinition.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

ActivityDefinition query ● ActivityDefinitionCreate mutation ● ActivityDefinitionList query ● ActivityDefinitionUpdate mutation