STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 plandefinition

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 URL to reference this asset
... identifier Σ0..*IdentifierLogical identifier(s) for the asset
... version Σ0..1stringThe version of the asset, if any
... name Σ0..1stringA machine-friendly name for the asset
... title Σ0..1stringA user-friendly title for the asset
... status ?!Σ1..1codedraft | active | inactive
LibraryStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the asset
... purpose 0..1stringDescribes the purpose of the asset
... usage 0..1stringDescribes the clinical usage of the asset
... publicationDate 0..1datePublication date for this version of the asset
... lastReviewDate 0..1dateLast review date for the asset
... effectivePeriod 0..1PeriodThe effective date range for the asset
... coverage 0..*UsageContextDescribes the context of use for this asset
... 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 of the publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*RelatedResourceRelated resources 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
... 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 asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) publishedurl : uri [0..1]A logical identifier for the asset such as the CMS or NQF identifiers for a measure. Note that at least one identifier is required for non-experimental active assetsidentifier : Identifier [0..*]The version of the asset, if any. 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 machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the assettitle : string [0..1]The status of the asset (this element modifies the meaning of other elements)status : code [1..1] « The status of the ActivityDefinition (Strength=Required)LibraryStatus! »Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the asset from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the assetpurpose : string [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset was publishedpublicationDate : date [0..1]The date on which the asset content was last reviewedlastReviewDate : date [0..1]The period during which the asset content is effectiveeffectivePeriod : Period [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge asset is applicablecoverage : UsageContext [0..*]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 asset (also known as the steward for the asset). This information is required for non-experimental active artifactspublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the assetcopyright : string [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource : RelatedResource [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]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 URL to reference this asset -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the asset --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the asset, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the asset -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the asset -->
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the asset -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the asset -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the asset -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the asset -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the asset --></effectivePeriod>
 <coverage><!-- 0..* UsageContext Describes the context of use for this asset --></coverage>
 <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 of the publisher --></contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource><!-- 0..* RelatedResource Related resources for the asset --></relatedResource>
 <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>
 <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 URL to reference this asset
  "identifier" : [{ Identifier }], // Logical identifier(s) for the asset
  "version" : "<string>", // The version of the asset, if any
  "name" : "<string>", // A machine-friendly name for the asset
  "title" : "<string>", // A user-friendly title for the asset
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the asset
  "purpose" : "<string>", // Describes the purpose of the asset
  "usage" : "<string>", // Describes the clinical usage of the asset
  "publicationDate" : "<date>", // Publication date for this version of the asset
  "lastReviewDate" : "<date>", // Last review date for the asset
  "effectivePeriod" : { Period }, // The effective date range for the asset
  "coverage" : [{ UsageContext }], // Describes the context of use for this asset
  "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 of the publisher
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ RelatedResource }], // Related resources 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
  "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 URL to reference this asset
  fhir:ActivityDefinition.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the asset
  fhir:ActivityDefinition.version [ string ]; # 0..1 The version of the asset, if any
  fhir:ActivityDefinition.name [ string ]; # 0..1 A machine-friendly name for the asset
  fhir:ActivityDefinition.title [ string ]; # 0..1 A user-friendly title for the asset
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | inactive
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ActivityDefinition.description [ string ]; # 0..1 Natural language description of the asset
  fhir:ActivityDefinition.purpose [ string ]; # 0..1 Describes the purpose of the asset
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:ActivityDefinition.publicationDate [ date ]; # 0..1 Publication date for this version of the asset
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the asset
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the asset
  fhir:ActivityDefinition.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this asset
  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 of the publisher
  fhir:ActivityDefinition.copyright [ string ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.relatedResource [ RelatedResource ], ... ; # 0..* Related resources 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.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 URL to reference this asset
... identifier Σ0..*IdentifierLogical identifier(s) for the asset
... version Σ0..1stringThe version of the asset, if any
... name Σ0..1stringA machine-friendly name for the asset
... title Σ0..1stringA user-friendly title for the asset
... status ?!Σ1..1codedraft | active | inactive
LibraryStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... description 0..1stringNatural language description of the asset
... purpose 0..1stringDescribes the purpose of the asset
... usage 0..1stringDescribes the clinical usage of the asset
... publicationDate 0..1datePublication date for this version of the asset
... lastReviewDate 0..1dateLast review date for the asset
... effectivePeriod 0..1PeriodThe effective date range for the asset
... coverage 0..*UsageContextDescribes the context of use for this asset
... 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 of the publisher
... copyright 0..1stringUse and/or publishing restrictions
... relatedResource 0..*RelatedResourceRelated resources 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
... 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 asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) publishedurl : uri [0..1]A logical identifier for the asset such as the CMS or NQF identifiers for a measure. Note that at least one identifier is required for non-experimental active assetsidentifier : Identifier [0..*]The version of the asset, if any. 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 machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the assettitle : string [0..1]The status of the asset (this element modifies the meaning of other elements)status : code [1..1] « The status of the ActivityDefinition (Strength=Required)LibraryStatus! »Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments (this element modifies the meaning of other elements)experimental : boolean [0..1]A free text natural language description of the asset from the consumer's perspectivedescription : string [0..1]A brief description of the purpose of the assetpurpose : string [0..1]A detailed description of how the asset is used from a clinical perspectiveusage : string [0..1]The date on which the asset was publishedpublicationDate : date [0..1]The date on which the asset content was last reviewedlastReviewDate : date [0..1]The period during which the asset content is effectiveeffectivePeriod : Period [0..1]Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge asset is applicablecoverage : UsageContext [0..*]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 asset (also known as the steward for the asset). This information is required for non-experimental active artifactspublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the assetcopyright : string [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedResource : RelatedResource [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]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 URL to reference this asset -->
 <identifier><!-- 0..* Identifier Logical identifier(s) for the asset --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the asset, if any -->
 <name value="[string]"/><!-- 0..1 A machine-friendly name for the asset -->
 <title value="[string]"/><!-- 0..1 A user-friendly title for the asset -->
 <status value="[code]"/><!-- 1..1 draft | active | inactive -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <description value="[string]"/><!-- 0..1 Natural language description of the asset -->
 <purpose value="[string]"/><!-- 0..1 Describes the purpose of the asset -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the asset -->
 <publicationDate value="[date]"/><!-- 0..1 Publication date for this version of the asset -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the asset -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the asset --></effectivePeriod>
 <coverage><!-- 0..* UsageContext Describes the context of use for this asset --></coverage>
 <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 of the publisher --></contact>
 <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedResource><!-- 0..* RelatedResource Related resources for the asset --></relatedResource>
 <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>
 <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 URL to reference this asset
  "identifier" : [{ Identifier }], // Logical identifier(s) for the asset
  "version" : "<string>", // The version of the asset, if any
  "name" : "<string>", // A machine-friendly name for the asset
  "title" : "<string>", // A user-friendly title for the asset
  "status" : "<code>", // R!  draft | active | inactive
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "description" : "<string>", // Natural language description of the asset
  "purpose" : "<string>", // Describes the purpose of the asset
  "usage" : "<string>", // Describes the clinical usage of the asset
  "publicationDate" : "<date>", // Publication date for this version of the asset
  "lastReviewDate" : "<date>", // Last review date for the asset
  "effectivePeriod" : { Period }, // The effective date range for the asset
  "coverage" : [{ UsageContext }], // Describes the context of use for this asset
  "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 of the publisher
  "copyright" : "<string>", // Use and/or publishing restrictions
  "relatedResource" : [{ RelatedResource }], // Related resources 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
  "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 URL to reference this asset
  fhir:ActivityDefinition.identifier [ Identifier ], ... ; # 0..* Logical identifier(s) for the asset
  fhir:ActivityDefinition.version [ string ]; # 0..1 The version of the asset, if any
  fhir:ActivityDefinition.name [ string ]; # 0..1 A machine-friendly name for the asset
  fhir:ActivityDefinition.title [ string ]; # 0..1 A user-friendly title for the asset
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | inactive
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ActivityDefinition.description [ string ]; # 0..1 Natural language description of the asset
  fhir:ActivityDefinition.purpose [ string ]; # 0..1 Describes the purpose of the asset
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the asset
  fhir:ActivityDefinition.publicationDate [ date ]; # 0..1 Publication date for this version of the asset
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the asset
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the asset
  fhir:ActivityDefinition.coverage [ UsageContext ], ... ; # 0..* Describes the context of use for this asset
  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 of the publisher
  fhir:ActivityDefinition.copyright [ string ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.relatedResource [ RelatedResource ], ... ; # 0..* Related resources 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.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)

14.1.3.1 Terminology Bindings

PathDefinitionTypeReference
ActivityDefinition.status The status of the ActivityDefinitionRequiredLibraryStatus
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

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

NameTypeDescriptionPaths
descriptionstringText search against the descriptionActivityDefinition.description
identifiertokenLogical identifier for the module (e.g. CMS-143)ActivityDefinition.identifier
statustokenStatus of the moduleActivityDefinition.status
titlestringText search against the titleActivityDefinition.title
topictokenTopics associated with the moduleActivityDefinition.topic
versionstringVersion of the module (e.g. 1.0.0)ActivityDefinition.version