STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

14.1 Resource ActivityDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

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

14.1.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Reasoning module.

An activity definition is a shareable, consumable description of some activity to be performed. It may be used to specify actions to be taken as part of an order set or protocol, or it may be used independently as part of a catalog of activities such as orderables.

For more information on how activity definitions can be used to construct request resources, see the Category Mapping and Realizing an ActivityDefinition topics below.

14.1.2 Boundaries and Relationships

In general, an activity definition is simply a conceptual description of some specific action that should be taken. An instance of an ActivityDefinition does not indicate that any action has been performed (as an event resource does), nor does it indicate the actual intent to carry out any particular action (as a request resource does).

Instead, an activity definition provides a reusable template that can potentially be used to construct specific request resources such as ProcedureRequest and MedicationRequest.

-->

This resource is referenced by MedicationRequest, MessageDefinition, PlanDefinition and Task

14.1.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition DomainResourceThe definition of a specific activity to be taken, independent of any particular patient or context
... url Σ0..1uriLogical uri to reference this activity definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... name Σ0..1stringName for this activity definition (Computer friendly)
... title Σ0..1stringName for this activity definition (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... description 0..1markdownNatural language description of the activity definition
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen activity definition approved by publisher
... lastReviewDate 0..1dateLast review date for the activity definition
... effectivePeriod Σ0..1PeriodThe effective date range for the activity definition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the asset
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated artifacts for the asset
... library 0..*Reference(Library)Logic used by the asset
... category 0..1codecommunication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
ActivityDefinitionCategory (Required)
... code 0..1CodeableConceptDetail type of activity
... timing[x] 0..1When activity is to occur
.... timingCodeableConceptCodeableConcept
.... timingTimingTiming
... location 0..1Reference(Location)Where it should happen
... participantType 0..*codepatient | practitioner | related-person
PlanActionParticipantType (Required)
... product[x] 0..1What's administered/supplied
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosageInstruction 0..*DosageInstructionDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
SNOMED CT Body Structures (Example)
... transform 0..1Reference(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... description 0..1stringNatural language description of the dynamic value
.... path 0..1stringThe path to the element to be set dynamically
.... language 0..1stringLanguage of the expression
.... expression 0..1stringAn expression that provides the dynamic value for the customization

doco Documentation for this format

UML Diagram (Legend)

ActivityDefinition (DomainResource)An absolute URL 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](resource.html#versions)url : uri [0..1]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 instanceidentifier : Identifier [0..*]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 are orderable. 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 assetsversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly title for the activity definitiontitle : string [0..1]The status of this activity definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the activity definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changesdate : dateTime [0..1]A free text natural language description of the activity definition from the consumer's perspectivedescription : markdown [0..1]Explains why this activity definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the activity definition content was or is planned to be effectiveeffectivePeriod : Period [0..1]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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction in which the activity definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Clinical topics related to the content of the assettopic : CodeableConcept [0..*]A contributor to the content of the asset, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the activity definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]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 definitioncopyright : markdown [0..1]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the assetlibrary : Reference [0..*] « Library »High-level categorization of the type of activitycategory : code [0..1] « High-level categorization of the type of activity in a protocol. (Strength=Required)ActivityDefinitionCategory! »Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encountercode : CodeableConcept [0..1]The period, timing or frequency upon which the described activity is to occurtiming[x] : Type [0..1] « CodeableConcept|Timing »Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etclocation : Reference [0..1] « Location »The type of participant in the actionparticipantType : code [0..*] « The type of participant for an action in the orderset (Strength=Required)PlanActionParticipantType! »Identifies the food, drug or other product being consumed or supplied in the activityproduct[x] : Type [0..1] « Reference(Medication|Substance)| CodeableConcept »Identifies the quantity expected to be consumed at once (per dose, per meal, etc.)quantity : Quantity(SimpleQuantity) [0..1]Provides detailed dosage instructions in the same way that they are described for MedicationRequest resourcesdosageInstruction : DosageInstruction [0..*]Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites)bodySite : CodeableConcept [0..*] « A code that identifies the anatomical location. (Strength=Example)SNOMED CT Body Structures?? »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 inputtransform : Reference [0..1] « StructureMap »DynamicValueA brief, natural language description of the intended semantics of the dynamic valuedescription : string [0..1]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 expressionpath : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression specifying the value of the customized elementexpression : string [0..1]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 resultdynamicValue[0..*]

XML Template

<ActivityDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical uri to reference this activity definition (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the activity definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the activity definition -->
 <name value="[string]"/><!-- 0..1 Name for this activity definition (Computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this activity definition (Human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the activity definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this activity definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <approvalDate value="[date]"/><!-- 0..1 When activity definition approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the activity definition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the activity definition --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the asset --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related artifacts for the asset --></relatedArtifact>
 <library><!-- 0..* Reference(Library) Logic used by the asset --></library>
 <category value="[code]"/><!-- 0..1 communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other -->
 <code><!-- 0..1 CodeableConcept Detail type of activity --></code>
 <timing[x]><!-- 0..1 CodeableConcept|Timing When activity is to occur --></timing[x]>
 <location><!-- 0..1 Reference(Location) Where it should happen --></location>
 <participantType value="[code]"/><!-- 0..* patient | practitioner | related-person -->
 <product[x]><!-- 0..1 Reference(Medication|Substance)|CodeableConcept What's administered/supplied --></product[x]>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) How much is administered/consumed/supplied --></quantity>
 <dosageInstruction><!-- 0..* DosageInstruction Detailed dosage instructions --></dosageInstruction>
 <bodySite><!-- 0..* CodeableConcept What part of body to perform on --></bodySite>
 <transform><!-- 0..1 Reference(StructureMap) Transform to apply the template --></transform>
 <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
  <description value="[string]"/><!-- 0..1 Natural language description of the dynamic value -->
  <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
  <language value="[string]"/><!-- 0..1 Language of the expression -->
  <expression value="[string]"/><!-- 0..1 An expression that provides the dynamic value for the customization -->
 </dynamicValue>
</ActivityDefinition>

JSON Template

{doco
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical uri to reference this activity definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // Name for this activity definition (Computer friendly)
  "title" : "<string>", // Name for this activity definition (Human friendly)
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "description" : "<markdown>", // Natural language description of the activity definition
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the asset
  "approvalDate" : "<date>", // When activity definition approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the activity definition
  "effectivePeriod" : { Period }, // The effective date range for the activity definition
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the asset
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related artifacts for the asset
  "library" : [{ Reference(Library) }], // Logic used by the asset
  "category" : "<code>", // communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
  "code" : { CodeableConcept }, // Detail type of activity
  // timing[x]: When activity is to occur. One of these 2:
  "timingCodeableConcept" : { CodeableConcept },
  "timingTiming" : { Timing },
  "location" : { Reference(Location) }, // Where it should happen
  "participantType" : ["<code>"], // patient | practitioner | related-person
  // product[x]: What's administered/supplied. One of these 2:
  "productReference" : { Reference(Medication|Substance) },
  "productCodeableConcept" : { CodeableConcept },
  "quantity" : { Quantity(SimpleQuantity) }, // How much is administered/consumed/supplied
  "dosageInstruction" : [{ DosageInstruction }], // Detailed dosage instructions
  "bodySite" : [{ CodeableConcept }], // What part of body to perform on
  "transform" : { Reference(StructureMap) }, // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "description" : "<string>", // Natural language description of the dynamic value
    "path" : "<string>", // The path to the element to be set dynamically
    "language" : "<string>", // Language of the expression
    "expression" : "<string>" // An expression that provides the dynamic value for the customization
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ActivityDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ActivityDefinition.url [ uri ]; # 0..1 Logical uri to reference this activity definition (globally unique)
  fhir:ActivityDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the activity definition
  fhir:ActivityDefinition.version [ string ]; # 0..1 Business version of the activity definition
  fhir:ActivityDefinition.name [ string ]; # 0..1 Name for this activity definition (Computer friendly)
  fhir:ActivityDefinition.title [ string ]; # 0..1 Name for this activity definition (Human friendly)
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | retired
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ActivityDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ActivityDefinition.description [ markdown ]; # 0..1 Natural language description of the activity definition
  fhir:ActivityDefinition.purpose [ markdown ]; # 0..1 Why this activity definition is defined
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:ActivityDefinition.approvalDate [ date ]; # 0..1 When activity definition approved by publisher
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the activity definition
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the activity definition
  fhir:ActivityDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:ActivityDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for activity definition (if applicable)
  fhir:ActivityDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the asset
  fhir:ActivityDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ActivityDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:ActivityDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ActivityDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Related artifacts for the asset
  fhir:ActivityDefinition.library [ Reference(Library) ], ... ; # 0..* Logic used by the asset
  fhir:ActivityDefinition.category [ code ]; # 0..1 communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
  fhir:ActivityDefinition.code [ CodeableConcept ]; # 0..1 Detail type of activity
  # ActivityDefinition.timing[x] : 0..1 When activity is to occur. One of these 2
    fhir:ActivityDefinition.timingCodeableConcept [ CodeableConcept ]
    fhir:ActivityDefinition.timingTiming [ Timing ]
  fhir:ActivityDefinition.location [ Reference(Location) ]; # 0..1 Where it should happen
  fhir:ActivityDefinition.participantType [ code ], ... ; # 0..* patient | practitioner | related-person
  # ActivityDefinition.product[x] : 0..1 What's administered/supplied. One of these 2
    fhir:ActivityDefinition.productReference [ Reference(Medication|Substance) ]
    fhir:ActivityDefinition.productCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much is administered/consumed/supplied
  fhir:ActivityDefinition.dosageInstruction [ DosageInstruction ], ... ; # 0..* Detailed dosage instructions
  fhir:ActivityDefinition.bodySite [ CodeableConcept ], ... ; # 0..* What part of body to perform on
  fhir:ActivityDefinition.transform [ Reference(StructureMap) ]; # 0..1 Transform to apply the template
  fhir:ActivityDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
    fhir:ActivityDefinition.dynamicValue.description [ string ]; # 0..1 Natural language description of the dynamic value
    fhir:ActivityDefinition.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
    fhir:ActivityDefinition.dynamicValue.language [ string ]; # 0..1 Language of the expression
    fhir:ActivityDefinition.dynamicValue.expression [ string ]; # 0..1 An expression that provides the dynamic value for the customization
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition DomainResourceThe definition of a specific activity to be taken, independent of any particular patient or context
... url Σ0..1uriLogical uri to reference this activity definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version Σ0..1stringBusiness version of the activity definition
... name Σ0..1stringName for this activity definition (Computer friendly)
... title Σ0..1stringName for this activity definition (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... description 0..1markdownNatural language description of the activity definition
... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen activity definition approved by publisher
... lastReviewDate 0..1dateLast review date for the activity definition
... effectivePeriod Σ0..1PeriodThe effective date range for the activity definition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the asset
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated artifacts for the asset
... library 0..*Reference(Library)Logic used by the asset
... category 0..1codecommunication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
ActivityDefinitionCategory (Required)
... code 0..1CodeableConceptDetail type of activity
... timing[x] 0..1When activity is to occur
.... timingCodeableConceptCodeableConcept
.... timingTimingTiming
... location 0..1Reference(Location)Where it should happen
... participantType 0..*codepatient | practitioner | related-person
PlanActionParticipantType (Required)
... product[x] 0..1What's administered/supplied
.... productReferenceReference(Medication | Substance)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosageInstruction 0..*DosageInstructionDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
SNOMED CT Body Structures (Example)
... transform 0..1Reference(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition
.... description 0..1stringNatural language description of the dynamic value
.... path 0..1stringThe path to the element to be set dynamically
.... language 0..1stringLanguage of the expression
.... expression 0..1stringAn expression that provides the dynamic value for the customization

doco Documentation for this format

UML Diagram (Legend)

ActivityDefinition (DomainResource)An absolute URL 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](resource.html#versions)url : uri [0..1]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 instanceidentifier : Identifier [0..*]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 are orderable. 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 assetsversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly title for the activity definitiontitle : string [0..1]The status of this activity definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the activity definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changesdate : dateTime [0..1]A free text natural language description of the activity definition from the consumer's perspectivedescription : markdown [0..1]Explains why this activity definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the activity definition content was or is planned to be effectiveeffectivePeriod : Period [0..1]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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction in which the activity definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Clinical topics related to the content of the assettopic : CodeableConcept [0..*]A contributor to the content of the asset, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the activity definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]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 definitioncopyright : markdown [0..1]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the assetlibrary : Reference [0..*] « Library »High-level categorization of the type of activitycategory : code [0..1] « High-level categorization of the type of activity in a protocol. (Strength=Required)ActivityDefinitionCategory! »Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encountercode : CodeableConcept [0..1]The period, timing or frequency upon which the described activity is to occurtiming[x] : Type [0..1] « CodeableConcept|Timing »Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etclocation : Reference [0..1] « Location »The type of participant in the actionparticipantType : code [0..*] « The type of participant for an action in the orderset (Strength=Required)PlanActionParticipantType! »Identifies the food, drug or other product being consumed or supplied in the activityproduct[x] : Type [0..1] « Reference(Medication|Substance)| CodeableConcept »Identifies the quantity expected to be consumed at once (per dose, per meal, etc.)quantity : Quantity(SimpleQuantity) [0..1]Provides detailed dosage instructions in the same way that they are described for MedicationRequest resourcesdosageInstruction : DosageInstruction [0..*]Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites)bodySite : CodeableConcept [0..*] « A code that identifies the anatomical location. (Strength=Example)SNOMED CT Body Structures?? »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 inputtransform : Reference [0..1] « StructureMap »DynamicValueA brief, natural language description of the intended semantics of the dynamic valuedescription : string [0..1]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 expressionpath : string [0..1]The media type of the language for the expressionlanguage : string [0..1]An expression specifying the value of the customized elementexpression : string [0..1]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 resultdynamicValue[0..*]

XML Template

<ActivityDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical uri to reference this activity definition (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the activity definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the activity definition -->
 <name value="[string]"/><!-- 0..1 Name for this activity definition (Computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this activity definition (Human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the activity definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this activity definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <approvalDate value="[date]"/><!-- 0..1 When activity definition approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the activity definition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the activity definition --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the asset --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related artifacts for the asset --></relatedArtifact>
 <library><!-- 0..* Reference(Library) Logic used by the asset --></library>
 <category value="[code]"/><!-- 0..1 communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other -->
 <code><!-- 0..1 CodeableConcept Detail type of activity --></code>
 <timing[x]><!-- 0..1 CodeableConcept|Timing When activity is to occur --></timing[x]>
 <location><!-- 0..1 Reference(Location) Where it should happen --></location>
 <participantType value="[code]"/><!-- 0..* patient | practitioner | related-person -->
 <product[x]><!-- 0..1 Reference(Medication|Substance)|CodeableConcept What's administered/supplied --></product[x]>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) How much is administered/consumed/supplied --></quantity>
 <dosageInstruction><!-- 0..* DosageInstruction Detailed dosage instructions --></dosageInstruction>
 <bodySite><!-- 0..* CodeableConcept What part of body to perform on --></bodySite>
 <transform><!-- 0..1 Reference(StructureMap) Transform to apply the template --></transform>
 <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
  <description value="[string]"/><!-- 0..1 Natural language description of the dynamic value -->
  <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
  <language value="[string]"/><!-- 0..1 Language of the expression -->
  <expression value="[string]"/><!-- 0..1 An expression that provides the dynamic value for the customization -->
 </dynamicValue>
</ActivityDefinition>

JSON Template

{doco
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical uri to reference this activity definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // Name for this activity definition (Computer friendly)
  "title" : "<string>", // Name for this activity definition (Human friendly)
  "status" : "<code>", // R!  draft | active | retired
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "description" : "<markdown>", // Natural language description of the activity definition
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the asset
  "approvalDate" : "<date>", // When activity definition approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the activity definition
  "effectivePeriod" : { Period }, // The effective date range for the activity definition
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the asset
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related artifacts for the asset
  "library" : [{ Reference(Library) }], // Logic used by the asset
  "category" : "<code>", // communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
  "code" : { CodeableConcept }, // Detail type of activity
  // timing[x]: When activity is to occur. One of these 2:
  "timingCodeableConcept" : { CodeableConcept },
  "timingTiming" : { Timing },
  "location" : { Reference(Location) }, // Where it should happen
  "participantType" : ["<code>"], // patient | practitioner | related-person
  // product[x]: What's administered/supplied. One of these 2:
  "productReference" : { Reference(Medication|Substance) },
  "productCodeableConcept" : { CodeableConcept },
  "quantity" : { Quantity(SimpleQuantity) }, // How much is administered/consumed/supplied
  "dosageInstruction" : [{ DosageInstruction }], // Detailed dosage instructions
  "bodySite" : [{ CodeableConcept }], // What part of body to perform on
  "transform" : { Reference(StructureMap) }, // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "description" : "<string>", // Natural language description of the dynamic value
    "path" : "<string>", // The path to the element to be set dynamically
    "language" : "<string>", // Language of the expression
    "expression" : "<string>" // An expression that provides the dynamic value for the customization
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ActivityDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ActivityDefinition.url [ uri ]; # 0..1 Logical uri to reference this activity definition (globally unique)
  fhir:ActivityDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the activity definition
  fhir:ActivityDefinition.version [ string ]; # 0..1 Business version of the activity definition
  fhir:ActivityDefinition.name [ string ]; # 0..1 Name for this activity definition (Computer friendly)
  fhir:ActivityDefinition.title [ string ]; # 0..1 Name for this activity definition (Human friendly)
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | retired
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ActivityDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ActivityDefinition.description [ markdown ]; # 0..1 Natural language description of the activity definition
  fhir:ActivityDefinition.purpose [ markdown ]; # 0..1 Why this activity definition is defined
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:ActivityDefinition.approvalDate [ date ]; # 0..1 When activity definition approved by publisher
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the activity definition
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the activity definition
  fhir:ActivityDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:ActivityDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for activity definition (if applicable)
  fhir:ActivityDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the asset
  fhir:ActivityDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ActivityDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:ActivityDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ActivityDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Related artifacts for the asset
  fhir:ActivityDefinition.library [ Reference(Library) ], ... ; # 0..* Logic used by the asset
  fhir:ActivityDefinition.category [ code ]; # 0..1 communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other
  fhir:ActivityDefinition.code [ CodeableConcept ]; # 0..1 Detail type of activity
  # ActivityDefinition.timing[x] : 0..1 When activity is to occur. One of these 2
    fhir:ActivityDefinition.timingCodeableConcept [ CodeableConcept ]
    fhir:ActivityDefinition.timingTiming [ Timing ]
  fhir:ActivityDefinition.location [ Reference(Location) ]; # 0..1 Where it should happen
  fhir:ActivityDefinition.participantType [ code ], ... ; # 0..* patient | practitioner | related-person
  # ActivityDefinition.product[x] : 0..1 What's administered/supplied. One of these 2
    fhir:ActivityDefinition.productReference [ Reference(Medication|Substance) ]
    fhir:ActivityDefinition.productCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much is administered/consumed/supplied
  fhir:ActivityDefinition.dosageInstruction [ DosageInstruction ], ... ; # 0..* Detailed dosage instructions
  fhir:ActivityDefinition.bodySite [ CodeableConcept ], ... ; # 0..* What part of body to perform on
  fhir:ActivityDefinition.transform [ Reference(StructureMap) ]; # 0..1 Transform to apply the template
  fhir:ActivityDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
    fhir:ActivityDefinition.dynamicValue.description [ string ]; # 0..1 Natural language description of the dynamic value
    fhir:ActivityDefinition.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
    fhir:ActivityDefinition.dynamicValue.language [ string ]; # 0..1 Language of the expression
    fhir:ActivityDefinition.dynamicValue.expression [ string ]; # 0..1 An expression that provides the dynamic value for the customization
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

14.1.3.1 Terminology Bindings

PathDefinitionTypeReference
ActivityDefinition.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
ActivityDefinition.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
ActivityDefinition.category High-level categorization of the type of activity in a protocol.RequiredActivityDefinitionCategory
ActivityDefinition.code Detailed type of planned activity; e.g. CBCUnknownNo details provided yet
ActivityDefinition.timing[x] Code describing the timing of an activity; e.g. BID, QDUnknownNo details provided yet
ActivityDefinition.participantType The type of participant for an action in the ordersetRequiredPlanActionParticipantType
ActivityDefinition.product[x] Code describing the type of substance or medicationUnknownNo details provided yet
ActivityDefinition.bodySite A code that identifies the anatomical location.ExampleSNOMED CT Body Structures

14.1.3.2 Category Mapping

The following table defines the mapping from ActivityDefinition categories to the appropriate intent resource:

Category codeResource
communicationCommunicationRequest
deviceDeviceUseRequest
diagnosticDiagnosticRequest
dietNutritionRequest
drugMedicationRequest
encounterAppointment
immunizationImmunizationRecommendation
observationObservation
procedureProcedureRequest
referralReferralRequest
supplySupplyRequest
visionVisionPrescription
otherN/A

14.1.3.3 Realizing an ActivityDefinition

An ActivityDefinition resource provides a description, or template, of an action to performed. These actions can be purely text-based descriptions of the action to be performed, only interpretable by a human user, or they can be structured definitions with enough information to construct a resource to represent the request directly. This process of converting the ActivityDefinition into a specific intent resource in a particular context is performed with the $apply operation.

In the simplest case, the process maps the elements specified in the ActivityDefinition to the corresponding elements on the intent resource of the appropriate type, based on the category of the definition as described in the category mapping table above.

More dynamic scenarios can be achieved in one of two ways, either by providing dynamicValue expressions, or by specifying a StructureMap that transforms the definition into the appropriate intent resource.

Note that systems will likely vary widely in the degree of support they provide for the $apply operation. In particular, the fact that a system supports applying definitions of one category, does not imply that it supports applying definitions for all categories. For example, a service focused on medication order sets may have sophisticated supported for the medication category, but no support at all for the encounter category.

14.1.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPathsIn Common
datedateThe activity definition publication dateActivityDefinition.date
descriptionstringText search against the description of the activity definitionActivityDefinition.description
effectivedateEffective time associated with the activity definitionActivityDefinition.effectivePeriod
identifiertokenExternal identifiers for the activity definitionActivityDefinition.identifier
jurisdictiontokenIntended jurisdiction for activity definitionActivityDefinition.jurisdiction
namestringName of the activity definitionActivityDefinition.name
publisherstringName of the publisher of the activity definitionActivityDefinition.publisher
statustokenThe current status of the activity definitionActivityDefinition.status
titlestringText search against the title of the activity definitionActivityDefinition.title
topictokenTopics associated with the moduleActivityDefinition.topic
urluriThe uri that identifies the activity definitionActivityDefinition.url
versiontokenThe version identifier of the activity definitionActivityDefinition.version