Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

12.22 Resource ActivityDefinition - Content

Clinical Decision Support icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Anonymous Compartments: 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.

12.22.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

An ActivityDefinition is a shareable, consumable description of some activity to be performed. It may be used to specify actions to be taken as part of a workflow, 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 Applying an ActivityDefinition topic below.

12.22.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 be used to construct specific request resources such as ServiceRequest and MedicationRequest.

Note that this is conceptually similar to the Task resource as well, with the distinction being that ActivityDefinition represents the description of a task in the abstract, while the Task resource is used to track a specific instance of a task as it moves through the steps of a workflow.

12.22.3 References to this Resource

12.22.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition TUDomainResourceThe definition of a specific activity to be taken, independent of any particular patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the activity definition

... version Σ0..1stringBusiness version of the activity definition
... name ΣC0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Participant Resource Types (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Jurisdiction (Extensible)

... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (Example)

... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

... library 0..*canonical(Library)Logic used by the activity definition

... kind Σ0..1codeKind of resource
Request Resource Types (Required)
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ0..1CodeableConceptDetail type of activity
Procedure Codes (SNOMED CT) (Example)
... intent 0..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action

.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
ActionParticipantType (Required)
.... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
.... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
ActionParticipantRole icon (Example)
.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc.
ActionParticipantFunction (Example)
... product[x] 0..1What's administered/supplied
SNOMED CT Medication Codes (Example)
.... productReferenceReference(Medication | Substance | Ingredient)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions

... bodySite 0..*CodeableConceptWhat part of body to perform on
SNOMED CT Body Structures (Example)

... specimenRequirement 0..*canonical(SpecimenDefinition)What specimens are required to perform this action

... observationRequirement 0..*canonical(ObservationDefinition)What observations are required to perform this action

... observationResultRequirement 0..*canonical(ObservationDefinition)What observations must be produced by this action

... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition

.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

ActivityDefinition (DomainResource) +MetadataResourceAn 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 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 serversurl : 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 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 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] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the activity definitiontitle : string [0..1]An explanatory or alternate title for the activity definition giving additional information about its contentsubtitle : 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] « null (Strength=Required)PublicationStatus! »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 usageexperimental : boolean [0..1]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 resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group| MedicinalProductDefinition|SubstanceDefinition| AdministrableProductDefinition|ManufacturedItemDefinition| PackagedProductDefinition)|canonical(EvidenceVariable); null (Strength=Extensible) ParticipantResourceTypes+ »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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the activity definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the activity definition from a consumer's perspectivedescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the activity definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this activity definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the activity definition is used from a clinical perspectiveusage : string [0..1]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]The date on which the resource 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 resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the activity definition content was or is planned to be in active useeffectivePeriod : Period [0..1]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 searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]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 activity definitionlibrary : canonical [0..*] « Library »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 resourcekind : code [0..1] « null (Strength=Required)RequestResourceTypes! »A profile to which the target of the activity definition is expected to conformprofile : canonical [0..1] « StructureDefinition »Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encountercode : CodeableConcept [0..1] « null (Strength=Example)ProcedureCodes(SNOMEDCT)?? »Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chainintent : code [0..1] « null (Strength=Required)RequestIntent! »Indicates how quickly the activity should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »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 (this element modifies the meaning of other elements)doNotPerform : boolean [0..1]The timing or frequency upon which the described activity is to occurtiming[x] : DataType [0..1] « Timing|Age|Range|Duration »If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etcasNeeded[x] : DataType [0..1] « boolean|CodeableConcept; null (Strength=Example) SNOMEDCTMedicationAsNeededRea...?? »Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »Identifies the food, drug or other product being consumed or supplied in the activityproduct[x] : DataType [0..1] « Reference(Medication|Substance| Ingredient)|CodeableConcept; null (Strength=Example)SNOMEDCTMedicationCodes?? »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 resourcesdosage : Dosage [0..*]Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites)bodySite : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTBodyStructures?? »Defines specimen requirements for the action to be performed, such as required specimens for a lab testspecimenRequirement : canonical [0..*] « SpecimenDefinition »Defines observation requirements for the action to be performed, such as body weight or surface areaobservationRequirement : canonical [0..*] « ObservationDefinition »Defines the observations that are expected to be produced by the actionobservationResultRequirement : canonical [0..*] « ObservationDefinition »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 : canonical [0..1] « StructureMap »ParticipantThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [1..1]An expression specifying the value of the customized elementexpression : Expression [1..1]Indicates who should participate in performing the action describedparticipant[0..*]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 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 Canonical identifier for this activity definition, represented as a URI (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]"/><!-- I 0..1 Name for this activity definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this activity definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the activity definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(AdministrableProductDefinition|
   Group|ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition)|canonical(EvidenceVariable) Type of individual the activity definition is intended for --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the activity definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this activity definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the activity definition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the activity definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the activity definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the activity definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the activity definition --></library>
 <kind value="[code]"/><!-- 0..1 Kind of resource -->
 <profile><!-- 0..1 canonical(StructureDefinition) What profile the resource needs to conform to --></profile>
 <code><!-- 0..1 CodeableConcept Detail type of activity --></code>
 <intent value="[code]"/><!-- 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if the activity should not be performed -->
 <timing[x]><!-- 0..1 Timing|Age|Range|Duration When activity is to occur --></timing[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]>
 <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
 <participant>  <!-- 0..* Who should participate in the action -->
  <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
  <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
  <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
    Group|HealthcareService|Location|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
  <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc. icon --></role>
  <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function>
 </participant>
 <product[x]><!-- 0..1 Reference(Ingredient|Medication|Substance)|CodeableConcept What's administered/supplied --></product[x]>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) How much is administered/consumed/supplied --></quantity>
 <dosage><!-- 0..* Dosage Detailed dosage instructions --></dosage>
 <bodySite><!-- 0..* CodeableConcept What part of body to perform on --></bodySite>
 <specimenRequirement><!-- 0..* canonical(SpecimenDefinition) What specimens are required to perform this action --></specimenRequirement>
 <observationRequirement><!-- 0..* canonical(ObservationDefinition) What observations are required to perform this action --></observationRequirement>
 <observationResultRequirement><!-- 0..* canonical(ObservationDefinition) What observations must be produced by this action --></observationResultRequirement>
 <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
 <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
  <path value="[string]"/><!-- 1..1 The path to the element to be set dynamically -->
  <expression><!-- 1..1 Expression An expression that provides the dynamic value for the customization --></expression>
 </dynamicValue>
</ActivityDefinition>

JSON Template

{doco
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this activity definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // I Name for this activity definition (computer friendly)
  "title" : "<string>", // Name for this activity definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the activity definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the activity definition is intended for. One of these 3:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(AdministrableProductDefinition|Group|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition) },
  "subjectCanonical" : "<canonical(EvidenceVariable)>",
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the activity definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the activity definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the activity definition was approved by publisher
  "lastReviewDate" : "<date>", // When the activity definition was last reviewed
  "effectivePeriod" : { Period }, // When the activity definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : ["<canonical(Library)>"], // Logic used by the activity definition
  "kind" : "<code>", // Kind of resource
  "profile" : "<canonical(StructureDefinition)>", // What profile the resource needs to conform to
  "code" : { CodeableConcept }, // Detail type of activity
  "intent" : "<code>", // proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if the activity should not be performed
  // timing[x]: When activity is to occur. One of these 4:
  "timingTiming" : { Timing },
  "timingAge" : { Age },
  "timingRange" : { Range },
  "timingDuration" : { Duration },
  // asNeeded[x]: Preconditions for service. One of these 2:
  "asNeededBoolean" : <boolean>,
  "asNeededCodeableConcept" : { CodeableConcept },
  "location" : { CodeableReference(Location) }, // Where it should happen
  "participant" : [{ // Who should participate in the action
    "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
    "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
    "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
    Group|HealthcareService|Location|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }, // Who or what can participate
    "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc. icon
    "function" : { CodeableConcept } // E.g. Author, Reviewer, Witness, etc.
  }],
  // product[x]: What's administered/supplied. One of these 2:
  "productReference" : { Reference(Ingredient|Medication|Substance) },
  "productCodeableConcept" : { CodeableConcept },
  "quantity" : { Quantity(SimpleQuantity) }, // How much is administered/consumed/supplied
  "dosage" : [{ Dosage }], // Detailed dosage instructions
  "bodySite" : [{ CodeableConcept }], // What part of body to perform on
  "specimenRequirement" : ["<canonical(SpecimenDefinition)>"], // What specimens are required to perform this action
  "observationRequirement" : ["<canonical(ObservationDefinition)>"], // What observations are required to perform this action
  "observationResultRequirement" : ["<canonical(ObservationDefinition)>"], // What observations must be produced by this action
  "transform" : "<canonical(StructureMap)>", // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "path" : "<string>", // R!  The path to the element to be set dynamically
    "expression" : { Expression } // R!  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 Canonical identifier for this activity definition, represented as a URI (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 I Name for this activity definition (computer friendly)
  fhir:ActivityDefinition.title [ string ]; # 0..1 Name for this activity definition (human friendly)
  fhir:ActivityDefinition.subtitle [ string ]; # 0..1 Subordinate title of the activity definition
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ActivityDefinition.subject[x] : 0..1 Type of individual the activity definition is intended for. One of these 3
    fhir:ActivityDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ActivityDefinition.subjectReference [ Reference(AdministrableProductDefinition|Group|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition|SubstanceDefinition) ]
    fhir:ActivityDefinition.subjectCanonical [ canonical(EvidenceVariable) ]
  fhir:ActivityDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ActivityDefinition.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:ActivityDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ActivityDefinition.description [ markdown ]; # 0..1 Natural language description of the activity definition
  fhir:ActivityDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ActivityDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for activity definition (if applicable)
  fhir:ActivityDefinition.purpose [ markdown ]; # 0..1 Why this activity definition is defined
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the activity definition
  fhir:ActivityDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.approvalDate [ date ]; # 0..1 When the activity definition was approved by publisher
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 When the activity definition was last reviewed
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 When the activity definition is expected to be used
  fhir:ActivityDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:ActivityDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ActivityDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ActivityDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ActivityDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ActivityDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ActivityDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the activity definition
  fhir:ActivityDefinition.kind [ code ]; # 0..1 Kind of resource
  fhir:ActivityDefinition.profile [ canonical(StructureDefinition) ]; # 0..1 What profile the resource needs to conform to
  fhir:ActivityDefinition.code [ CodeableConcept ]; # 0..1 Detail type of activity
  fhir:ActivityDefinition.intent [ code ]; # 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:ActivityDefinition.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:ActivityDefinition.doNotPerform [ boolean ]; # 0..1 True if the activity should not be performed
  # ActivityDefinition.timing[x] : 0..1 When activity is to occur. One of these 4
    fhir:ActivityDefinition.timingTiming [ Timing ]
    fhir:ActivityDefinition.timingAge [ Age ]
    fhir:ActivityDefinition.timingRange [ Range ]
    fhir:ActivityDefinition.timingDuration [ Duration ]
  # ActivityDefinition.asNeeded[x] : 0..1 Preconditions for service. One of these 2
    fhir:ActivityDefinition.asNeededBoolean [ boolean ]
    fhir:ActivityDefinition.asNeededCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.location [ CodeableReference(Location) ]; # 0..1 Where it should happen
  fhir:ActivityDefinition.participant [ # 0..* Who should participate in the action
    fhir:ActivityDefinition.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
    fhir:ActivityDefinition.participant.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
    fhir:ActivityDefinition.participant.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate
    fhir:ActivityDefinition.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc.
    fhir:ActivityDefinition.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc.
  ], ...;
  # ActivityDefinition.product[x] : 0..1 What's administered/supplied. One of these 2
    fhir:ActivityDefinition.productReference [ Reference(Ingredient|Medication|Substance) ]
    fhir:ActivityDefinition.productCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much is administered/consumed/supplied
  fhir:ActivityDefinition.dosage [ Dosage ], ... ; # 0..* Detailed dosage instructions
  fhir:ActivityDefinition.bodySite [ CodeableConcept ], ... ; # 0..* What part of body to perform on
  fhir:ActivityDefinition.specimenRequirement [ canonical(SpecimenDefinition) ], ... ; # 0..* What specimens are required to perform this action
  fhir:ActivityDefinition.observationRequirement [ canonical(ObservationDefinition) ], ... ; # 0..* What observations are required to perform this action
  fhir:ActivityDefinition.observationResultRequirement [ canonical(ObservationDefinition) ], ... ; # 0..* What observations must be produced by this action
  fhir:ActivityDefinition.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
  fhir:ActivityDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
    fhir:ActivityDefinition.dynamicValue.path [ string ]; # 1..1 The path to the element to be set dynamically
    fhir:ActivityDefinition.dynamicValue.expression [ Expression ]; # 1..1 An expression that provides the dynamic value for the customization
  ], ...;
]

Changes since R4

ActivityDefinition
ActivityDefinition.subject[x]
  • Add Type canonical(EvidenceVariable), canonical(EvidenceVariable)
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
ActivityDefinition.timing[x]
  • Remove Types dateTime, Period, Period
  • Remove Types dateTime, Period, Period
ActivityDefinition.asNeeded[x]
  • Added Element
ActivityDefinition.location
  • Type changed from Reference(Location) to CodeableReference
  • Type changed from Reference(Location) to CodeableReference
ActivityDefinition.participant.type
  • Min Cardinality changed from 1 to 0
  • Min Cardinality changed from 1 to 0
ActivityDefinition.participant.typeCanonical
  • Added Element
ActivityDefinition.participant.typeReference
  • Added Element
ActivityDefinition.participant.function
  • Added Element
ActivityDefinition.specimenRequirement
  • Type changed from Reference(SpecimenDefinition) to canonical(SpecimenDefinition)
  • Type changed from Reference(SpecimenDefinition) to canonical(SpecimenDefinition)
ActivityDefinition.observationRequirement
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
ActivityDefinition.observationResultRequirement
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 9 tests that all execute ok. 2 fail round-trip testing and 9 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition TUDomainResourceThe definition of a specific activity to be taken, independent of any particular patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the activity definition

... version Σ0..1stringBusiness version of the activity definition
... name ΣC0..1stringName for this activity definition (computer friendly)
... title Σ0..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Participant Resource Types (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description Σ0..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Jurisdiction (Extensible)

... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1stringDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (Example)

... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

... library 0..*canonical(Library)Logic used by the activity definition

... kind Σ0..1codeKind of resource
Request Resource Types (Required)
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code Σ0..1CodeableConceptDetail type of activity
Procedure Codes (SNOMED CT) (Example)
... intent 0..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] 0..1When activity is to occur
.... timingTimingTiming
.... timingAgeAge
.... timingRangeRange
.... timingDurationDuration
... asNeeded[x] Σ0..1Preconditions for service
SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action

.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
ActionParticipantType (Required)
.... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
.... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
ActionParticipantRole icon (Example)
.... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc.
ActionParticipantFunction (Example)
... product[x] 0..1What's administered/supplied
SNOMED CT Medication Codes (Example)
.... productReferenceReference(Medication | Substance | Ingredient)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions

... bodySite 0..*CodeableConceptWhat part of body to perform on
SNOMED CT Body Structures (Example)

... specimenRequirement 0..*canonical(SpecimenDefinition)What specimens are required to perform this action

... observationRequirement 0..*canonical(ObservationDefinition)What observations are required to perform this action

... observationResultRequirement 0..*canonical(ObservationDefinition)What observations must be produced by this action

... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue 0..*BackboneElementDynamic aspects of the definition

.... path 1..1stringThe path to the element to be set dynamically
.... expression 1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

ActivityDefinition (DomainResource) +MetadataResourceAn 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 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 serversurl : 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 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 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] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the activity definitiontitle : string [0..1]An explanatory or alternate title for the activity definition giving additional information about its contentsubtitle : 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] « null (Strength=Required)PublicationStatus! »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 usageexperimental : boolean [0..1]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 resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group| MedicinalProductDefinition|SubstanceDefinition| AdministrableProductDefinition|ManufacturedItemDefinition| PackagedProductDefinition)|canonical(EvidenceVariable); null (Strength=Extensible) ParticipantResourceTypes+ »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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the activity definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the activity definition from a consumer's perspectivedescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the activity definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this activity definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the activity definition is used from a clinical perspectiveusage : string [0..1]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]The date on which the resource 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 resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the activity definition content was or is planned to be in active useeffectivePeriod : Period [0..1]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 searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]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 activity definitionlibrary : canonical [0..*] « Library »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 resourcekind : code [0..1] « null (Strength=Required)RequestResourceTypes! »A profile to which the target of the activity definition is expected to conformprofile : canonical [0..1] « StructureDefinition »Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encountercode : CodeableConcept [0..1] « null (Strength=Example)ProcedureCodes(SNOMEDCT)?? »Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chainintent : code [0..1] « null (Strength=Required)RequestIntent! »Indicates how quickly the activity should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »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 (this element modifies the meaning of other elements)doNotPerform : boolean [0..1]The timing or frequency upon which the described activity is to occurtiming[x] : DataType [0..1] « Timing|Age|Range|Duration »If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etcasNeeded[x] : DataType [0..1] « boolean|CodeableConcept; null (Strength=Example) SNOMEDCTMedicationAsNeededRea...?? »Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »Identifies the food, drug or other product being consumed or supplied in the activityproduct[x] : DataType [0..1] « Reference(Medication|Substance| Ingredient)|CodeableConcept; null (Strength=Example)SNOMEDCTMedicationCodes?? »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 resourcesdosage : Dosage [0..*]Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites)bodySite : CodeableConcept [0..*] « null (Strength=Example)SNOMEDCTBodyStructures?? »Defines specimen requirements for the action to be performed, such as required specimens for a lab testspecimenRequirement : canonical [0..*] « SpecimenDefinition »Defines observation requirements for the action to be performed, such as body weight or surface areaobservationRequirement : canonical [0..*] « ObservationDefinition »Defines the observations that are expected to be produced by the actionobservationResultRequirement : canonical [0..*] « ObservationDefinition »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 : canonical [0..1] « StructureMap »ParticipantThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [1..1]An expression specifying the value of the customized elementexpression : Expression [1..1]Indicates who should participate in performing the action describedparticipant[0..*]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 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 Canonical identifier for this activity definition, represented as a URI (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]"/><!-- I 0..1 Name for this activity definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this activity definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the activity definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(AdministrableProductDefinition|
   Group|ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition)|canonical(EvidenceVariable) Type of individual the activity definition is intended for --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the activity definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this activity definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the activity definition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the activity definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the activity definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the activity definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the activity definition --></library>
 <kind value="[code]"/><!-- 0..1 Kind of resource -->
 <profile><!-- 0..1 canonical(StructureDefinition) What profile the resource needs to conform to --></profile>
 <code><!-- 0..1 CodeableConcept Detail type of activity --></code>
 <intent value="[code]"/><!-- 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <doNotPerform value="[boolean]"/><!-- 0..1 True if the activity should not be performed -->
 <timing[x]><!-- 0..1 Timing|Age|Range|Duration When activity is to occur --></timing[x]>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]>
 <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
 <participant>  <!-- 0..* Who should participate in the action -->
  <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
  <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
  <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
    Group|HealthcareService|Location|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
  <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc. icon --></role>
  <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function>
 </participant>
 <product[x]><!-- 0..1 Reference(Ingredient|Medication|Substance)|CodeableConcept What's administered/supplied --></product[x]>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) How much is administered/consumed/supplied --></quantity>
 <dosage><!-- 0..* Dosage Detailed dosage instructions --></dosage>
 <bodySite><!-- 0..* CodeableConcept What part of body to perform on --></bodySite>
 <specimenRequirement><!-- 0..* canonical(SpecimenDefinition) What specimens are required to perform this action --></specimenRequirement>
 <observationRequirement><!-- 0..* canonical(ObservationDefinition) What observations are required to perform this action --></observationRequirement>
 <observationResultRequirement><!-- 0..* canonical(ObservationDefinition) What observations must be produced by this action --></observationResultRequirement>
 <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
 <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
  <path value="[string]"/><!-- 1..1 The path to the element to be set dynamically -->
  <expression><!-- 1..1 Expression An expression that provides the dynamic value for the customization --></expression>
 </dynamicValue>
</ActivityDefinition>

JSON Template

{doco
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this activity definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // I Name for this activity definition (computer friendly)
  "title" : "<string>", // Name for this activity definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the activity definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the activity definition is intended for. One of these 3:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(AdministrableProductDefinition|Group|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition) },
  "subjectCanonical" : "<canonical(EvidenceVariable)>",
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the activity definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the activity definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the activity definition was approved by publisher
  "lastReviewDate" : "<date>", // When the activity definition was last reviewed
  "effectivePeriod" : { Period }, // When the activity definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : ["<canonical(Library)>"], // Logic used by the activity definition
  "kind" : "<code>", // Kind of resource
  "profile" : "<canonical(StructureDefinition)>", // What profile the resource needs to conform to
  "code" : { CodeableConcept }, // Detail type of activity
  "intent" : "<code>", // proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if the activity should not be performed
  // timing[x]: When activity is to occur. One of these 4:
  "timingTiming" : { Timing },
  "timingAge" : { Age },
  "timingRange" : { Range },
  "timingDuration" : { Duration },
  // asNeeded[x]: Preconditions for service. One of these 2:
  "asNeededBoolean" : <boolean>,
  "asNeededCodeableConcept" : { CodeableConcept },
  "location" : { CodeableReference(Location) }, // Where it should happen
  "participant" : [{ // Who should participate in the action
    "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
    "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
    "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
    Group|HealthcareService|Location|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }, // Who or what can participate
    "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc. icon
    "function" : { CodeableConcept } // E.g. Author, Reviewer, Witness, etc.
  }],
  // product[x]: What's administered/supplied. One of these 2:
  "productReference" : { Reference(Ingredient|Medication|Substance) },
  "productCodeableConcept" : { CodeableConcept },
  "quantity" : { Quantity(SimpleQuantity) }, // How much is administered/consumed/supplied
  "dosage" : [{ Dosage }], // Detailed dosage instructions
  "bodySite" : [{ CodeableConcept }], // What part of body to perform on
  "specimenRequirement" : ["<canonical(SpecimenDefinition)>"], // What specimens are required to perform this action
  "observationRequirement" : ["<canonical(ObservationDefinition)>"], // What observations are required to perform this action
  "observationResultRequirement" : ["<canonical(ObservationDefinition)>"], // What observations must be produced by this action
  "transform" : "<canonical(StructureMap)>", // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "path" : "<string>", // R!  The path to the element to be set dynamically
    "expression" : { Expression } // R!  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 Canonical identifier for this activity definition, represented as a URI (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 I Name for this activity definition (computer friendly)
  fhir:ActivityDefinition.title [ string ]; # 0..1 Name for this activity definition (human friendly)
  fhir:ActivityDefinition.subtitle [ string ]; # 0..1 Subordinate title of the activity definition
  fhir:ActivityDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ActivityDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ActivityDefinition.subject[x] : 0..1 Type of individual the activity definition is intended for. One of these 3
    fhir:ActivityDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ActivityDefinition.subjectReference [ Reference(AdministrableProductDefinition|Group|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition|SubstanceDefinition) ]
    fhir:ActivityDefinition.subjectCanonical [ canonical(EvidenceVariable) ]
  fhir:ActivityDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ActivityDefinition.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:ActivityDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ActivityDefinition.description [ markdown ]; # 0..1 Natural language description of the activity definition
  fhir:ActivityDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ActivityDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for activity definition (if applicable)
  fhir:ActivityDefinition.purpose [ markdown ]; # 0..1 Why this activity definition is defined
  fhir:ActivityDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the activity definition
  fhir:ActivityDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ActivityDefinition.approvalDate [ date ]; # 0..1 When the activity definition was approved by publisher
  fhir:ActivityDefinition.lastReviewDate [ date ]; # 0..1 When the activity definition was last reviewed
  fhir:ActivityDefinition.effectivePeriod [ Period ]; # 0..1 When the activity definition is expected to be used
  fhir:ActivityDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:ActivityDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ActivityDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ActivityDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ActivityDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ActivityDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ActivityDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the activity definition
  fhir:ActivityDefinition.kind [ code ]; # 0..1 Kind of resource
  fhir:ActivityDefinition.profile [ canonical(StructureDefinition) ]; # 0..1 What profile the resource needs to conform to
  fhir:ActivityDefinition.code [ CodeableConcept ]; # 0..1 Detail type of activity
  fhir:ActivityDefinition.intent [ code ]; # 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:ActivityDefinition.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:ActivityDefinition.doNotPerform [ boolean ]; # 0..1 True if the activity should not be performed
  # ActivityDefinition.timing[x] : 0..1 When activity is to occur. One of these 4
    fhir:ActivityDefinition.timingTiming [ Timing ]
    fhir:ActivityDefinition.timingAge [ Age ]
    fhir:ActivityDefinition.timingRange [ Range ]
    fhir:ActivityDefinition.timingDuration [ Duration ]
  # ActivityDefinition.asNeeded[x] : 0..1 Preconditions for service. One of these 2
    fhir:ActivityDefinition.asNeededBoolean [ boolean ]
    fhir:ActivityDefinition.asNeededCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.location [ CodeableReference(Location) ]; # 0..1 Where it should happen
  fhir:ActivityDefinition.participant [ # 0..* Who should participate in the action
    fhir:ActivityDefinition.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
    fhir:ActivityDefinition.participant.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
    fhir:ActivityDefinition.participant.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate
    fhir:ActivityDefinition.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc.
    fhir:ActivityDefinition.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc.
  ], ...;
  # ActivityDefinition.product[x] : 0..1 What's administered/supplied. One of these 2
    fhir:ActivityDefinition.productReference [ Reference(Ingredient|Medication|Substance) ]
    fhir:ActivityDefinition.productCodeableConcept [ CodeableConcept ]
  fhir:ActivityDefinition.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much is administered/consumed/supplied
  fhir:ActivityDefinition.dosage [ Dosage ], ... ; # 0..* Detailed dosage instructions
  fhir:ActivityDefinition.bodySite [ CodeableConcept ], ... ; # 0..* What part of body to perform on
  fhir:ActivityDefinition.specimenRequirement [ canonical(SpecimenDefinition) ], ... ; # 0..* What specimens are required to perform this action
  fhir:ActivityDefinition.observationRequirement [ canonical(ObservationDefinition) ], ... ; # 0..* What observations are required to perform this action
  fhir:ActivityDefinition.observationResultRequirement [ canonical(ObservationDefinition) ], ... ; # 0..* What observations must be produced by this action
  fhir:ActivityDefinition.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
  fhir:ActivityDefinition.dynamicValue [ # 0..* Dynamic aspects of the definition
    fhir:ActivityDefinition.dynamicValue.path [ string ]; # 1..1 The path to the element to be set dynamically
    fhir:ActivityDefinition.dynamicValue.expression [ Expression ]; # 1..1 An expression that provides the dynamic value for the customization
  ], ...;
]

Changes since Release 4

ActivityDefinition
ActivityDefinition.subject[x]
  • Add Type canonical(EvidenceVariable), canonical(EvidenceVariable)
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
ActivityDefinition.timing[x]
  • Remove Types dateTime, Period, Period
  • Remove Types dateTime, Period, Period
ActivityDefinition.asNeeded[x]
  • Added Element
ActivityDefinition.location
  • Type changed from Reference(Location) to CodeableReference
  • Type changed from Reference(Location) to CodeableReference
ActivityDefinition.participant.type
  • Min Cardinality changed from 1 to 0
  • Min Cardinality changed from 1 to 0
ActivityDefinition.participant.typeCanonical
  • Added Element
ActivityDefinition.participant.typeReference
  • Added Element
ActivityDefinition.participant.function
  • Added Element
ActivityDefinition.specimenRequirement
  • Type changed from Reference(SpecimenDefinition) to canonical(SpecimenDefinition)
  • Type changed from Reference(SpecimenDefinition) to canonical(SpecimenDefinition)
ActivityDefinition.observationRequirement
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
ActivityDefinition.observationResultRequirement
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)
  • Type changed from Reference(ObservationDefinition) to canonical(ObservationDefinition)

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 9 tests that all execute ok. 2 fail round-trip testing and 9 r3 resources are invalid (0 errors).)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

12.22.4.1 Terminology Bindings

PathDefinitionTypeReference
ActivityDefinition.status

The lifecycle status of an artifact.

RequiredPublicationStatus
ActivityDefinition.subject[x]

All Resource Types that represent participant resources

ExtensibleParticipantResourceTypes
ActivityDefinition.jurisdiction

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

ExtensibleJurisdiction ValueSet
ActivityDefinition.topic

High-level categorization of the definition, used for searching, sorting, and filtering.

ExampleDefinitionTopic
ActivityDefinition.kind

All Resource Types that represent request resources

RequiredRequestResourceTypes
ActivityDefinition.code

Procedure Code: All SNOMED CT procedure codes.

ExampleProcedureCodes(SNOMEDCT)
ActivityDefinition.intent

Codes indicating the degree of authority/intentionality associated with a request.

RequiredRequestIntent
ActivityDefinition.priority

Identifies the level of importance to be assigned to actioning the request.

RequiredRequestPriority
ActivityDefinition.asNeeded[x]

This value set includes all clinical findings from SNOMED CT - provided as an exemplar value set.

ExampleSNOMEDCTMedicationAsNeededReasonCodes
ActivityDefinition.participant.type

The type of participant for the action.

RequiredActionParticipantType
ActivityDefinition.participant.role

Either a practitioner role or a relationship type. Note from UTG import - may have been a temporary entry that subsequently disappeared from the FHIR source; unable to locate. Version set to 0.1.0

ExampleActionParticipantRole icon
ActivityDefinition.participant.function

The function performed by the participant for the action.

ExampleActionParticipantFunction
ActivityDefinition.product[x]

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.

ExampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySite

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

ExampleSNOMEDCTBodyStructures

12.22.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
img cnl-1Warning ActivityDefinition.urlURL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')

12.22.4.3 Applying 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 or activity directly. This process of converting the ActivityDefinition into a specific 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 a resource of the appropriate type, using the kind element of the definition to determine the type of resource to be created.

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 request 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 support for MedicationRequest activities, but no support at all for the ServiceRequest activities.

The following diagram illustrates the relationship between the PlanDefinition and ActivityDefinition resources, as well as a typical application to CarePlan, RequestOrchestration, and Request resources:

relationship-between-action-and-activity-definition

To accommodate the variability in systems and use cases, this specification is not prescriptive about exactly how an ActivityDefinition is applied to produce target request or event resources. However, the approach depicted above provides a general framework for the process, and the following steps provide more detail on the potential approach:

  1. Create the target resource of the type specified by the kind element and focused on the Patient in context
  2. Set the status of the target resource to draft
  3. Apply the structural elements of the ActivityDefinition to the target resource such as code, timing, doNotPerform, product, quantity, dosage, and so on
  4. Resolve the participant element based on the user in context
  5. Resolve the location element based on the location in context
  6. If the transform element is specified, apply the transform to the resource. Note that the referenced StructureMap may actually construct the resource, rather than taking an instance. See the StructureMap for more information
  7. Apply any dynamicValue elements (in the order in which they appear in the ActivityDefinition resource) by evaluating the expression and setting the value of the appropriate element of the target resource (as specified by the dynamicValue.path element)

Note that the parameters to the $apply operation are available within dynamicValue CQL and FHIRPath expressions as context variables, accessible by the name of the parameter prefixed with a percent (%) symbol. For example, to access the subject given to the apply, use the expression %subject.

Note that result of this operation is transient (i.e. none of the resources created by the operation are persisted in the server, they are all returned as contained resources in the result). The result effectively represents a proposed set of activities, and it is up to the caller to determine whether and how those activities are actually carried out.

12.22.4.4 Profiling ActivityDefinition

Because the ActivityDefinition resource can be used to describe many different types of request resources, profiles of the resource will be useful in communicating additional constraints and expectations about how the resource should be used in a particular context. For example, a profile of ActivityDefinition may specify that it is intended to describe medication orders within an order set. Such a profile would indicate that the quantity element should not be used, but the dosage element must be.

12.22.5 Search Parameters

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

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the activity definition(ActivityDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the activity definition(ActivityDefinition.useContext.value as Quantity) | (ActivityDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the activity definitionActivityDefinition.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the activity definitionOn ActivityDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)
context-type-valuecompositeA use context type and value assigned to the activity definitionOn ActivityDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
date NdateThe activity definition publication dateActivityDefinition.date
depends-onreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library
(Library, Any)
derived-fromreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
description NstringThe description of the activity definitionActivityDefinition.description
effectivedateThe time during which the activity definition is intended to be in useActivityDefinition.effectivePeriod
identifiertokenExternal identifier for the activity definitionActivityDefinition.identifier
jurisdictiontokenIntended jurisdiction for the activity definitionActivityDefinition.jurisdiction
kindtokenThe kind of activity definitionActivityDefinition.kind
name NstringComputationally friendly name of the activity definitionActivityDefinition.name
predecessorreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisher NstringName of the publisher of the activity definitionActivityDefinition.publisher
status NtokenThe current status of the activity definitionActivityDefinition.status
successorreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='successor').resource
(Any)
title NstringThe human-friendly name of the activity definitionActivityDefinition.title
topictokenTopics associated with the moduleActivityDefinition.topic
url NuriThe uri that identifies the activity definitionActivityDefinition.url
version NtokenThe business version of the activity definitionActivityDefinition.version