Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). 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

12.17.11.2 12.21.12.2 StructureDefinition: ShareableActivityDefinition Shareable ActivityDefinition

Clinical Decision Support Work Group   Maturity Level : 1 0 Trial Use Use Context : Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/shareableactivitydefinition

Enforces the minimum information set for the activity definition metadata required by HL7 and other organizations that share and publish activity definitions

This profile was published on [no date] Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

12.17.11.2.1 12.21.12.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

This structure is derived from ActivityDefinition .

Summary

Mandatory: 6 elements
Must-Support: 6 elements

This structure is derived from ActivityDefinition .

Name Flags Card. Type Description & Constraints doco
. . ActivityDefinition 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
. . . url 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
. . . identifier S 0 .. * Identifier Additional identifier for the activity definition
. . . version 1..1 string Business version of the activity definition
. . . title S 0..1 string Name for this activity definition (human friendly)
. . . experimental 1..1 boolean For testing purposes, not real usage
. . . date S 0..1 dateTime Date last changed
. . . publisher 1..1 string Name of the publisher (organization or individual)
. . . contact S 0 .. * ContactDetail Contact details for the publisher
. . . description 1..1 markdown Natural language description of the activity definition
. . . useContext S 0 .. * UsageContext The context that the content is intended to support
. . . jurisdiction S 0 .. * CodeableConcept Intended jurisdiction for activity definition (if applicable)

doco Documentation for this format
I I I I I I I I I I I I I I I I Timing timingDateTime I I I I 1..1 I I I I I I I I I I I
Name Flags Card. Type Description & Constraints doco
. . ActivityDefinition I 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
. . . identifier S Σ I 0..* Identifier Additional identifier for the activity definition
. . . version Σ I 1..1 string Business version of the activity definition
. . . name Σ I 1..1 string Name for this activity definition (computer friendly)
. . . title S Σ I 0..1 string Name for this activity definition (human friendly)
. . . subtitle I 0..1 string Subordinate title of the activity definition
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ) ): The lifecycle status of an artifact.

. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . subject[x] I 0..1 Type of individual the activity definition is intended for
Binding: Subject type ( extensible ) ): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference (group.html) ( Group )
. . . . subjectCanonical canonical (Any)
. . . date S Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 string Name of the publisher (organization or individual)
. . . contact S Σ I 0..* ContactDetail Contact details for the publisher
. . . description Σ I 1..1 markdown Natural language description of the activity definition
. . . useContext S Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction S Σ I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ( extensible ) ): Countries and regions within which this artifact is targeted for use.


. . . purpose 0..1 markdown Why this activity definition is defined
. . . usage 0..1 string Describes the clinical usage of the activity definition
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . approvalDate 0..1 date When the activity definition was approved by publisher
. . . lastReviewDate 0..1 date When the activity definition was last reviewed
. . . effectivePeriod Σ I 0..1 Period When the activity definition is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic ( example ) ): High-level categorization of the definition, used for searching, sorting, and filtering.


. . . author 0..* ContactDetail Who authored the content
. . . editor 0..* ContactDetail Who edited the content
. . . reviewer 0..* ContactDetail Who reviewed the content
. . . endorser 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
. . . library 0..* canonical ( Library ) Logic used by the activity definition
. . . kind Σ I 0..1 code Kind of resource
Binding: RequestResourceType ( required ) ): The kind of activity the definition is describing.

. . . profile 0..1 canonical ( StructureDefinition ) What profile the resource needs to conform to
. . . code Σ I 0..1 CodeableConcept Detail type of activity
Binding: Procedure Codes (SNOMED CT) ( example ) ): Detailed type of the activity; e.g. CBC.

. . . intent 0..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent ( required ) ): Codes indicating the degree of authority/intentionality associated with a request.

. . . priority 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . doNotPerform ?! Σ I 0..1 boolean True if the activity should not be performed
. . . timing[x] 0..1 When activity is to occur
. . . . timingTiming dateTime Timing
. . . . timingAge Age
. . . . timingPeriod timingRange Period timingRange Range
. . . . timingDuration Duration
. . . location 0..1 Reference CodeableReference ( Location ) Where it should happen
. . . participant 0..* BackboneElement Who should participate in the action
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | related-person practitionerrole | device relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity.

.... typeReference 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) Who or what can participate
. . . . role I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: Action participant role ActionParticipantRole ( example ) ): Defines roles played by participants for the action.

. . product[x] . . function I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.
Binding: ActionParticipantFunction ( example )
... product[x] 0..1 What's administered/supplied
Binding: SNOMED CT Medication Codes ( example ) ): Code describing the type of substance or medication.

. . . . productReference Reference (medication.html ( Medication | substance.html) Substance | Ingredient )
. . . . productCodeableConcept CodeableConcept
. . . quantity 0..1 SimpleQuantity How much is administered/consumed/supplied
. . . dosage 0..* Dosage Detailed dosage instructions
. . . bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMED CT Body Structures ( example ) ): A code that identifies the anatomical location.


. . . specimenRequirement 0..* Reference ( SpecimenDefinition ) What specimens are required to perform this action
. . . observationRequirement 0..* Reference ( ObservationDefinition ) What observations are required to perform this action
. . . observationResultRequirement 0..* Reference ( ObservationDefinition ) What observations must be produced by this action
. . . transform 0..1 canonical ( StructureMap ) Transform to apply the template
. . . dynamicValue 0..* BackboneElement Dynamic aspects of the definition
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . path 1..1 string The path to the element to be set dynamically
. . . . expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format 
<!-- Shareable ActivityDefinition -->doco

<ActivityDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <

 <contained><!-- 0..* Resource 

     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..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]"/><!-- ?? 1..1 Business version of the activity definition -->
 <name value="[string]"/><!-- ?? 1..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]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <</subject[x]>

 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for   --></subject[x]>

 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..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 value="[canonical]"/><!-- ?? 0..* Logic used by the activity definition -->
 <kind value="[code]"/><!-- ?? 0..1 Kind of resource   -->
 <profile value="[canonical]"/><!-- ?? 0..1 What profile the resource needs to conform to -->
 <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]>
 <

 <timing[x]><!-- ?? 0..1 Timing|Age|Range|Duration 
     When activity is to occur --></timing[x]>
 <location><!-- ?? 0..1 CodeableReference 

     Where it should happen --></location>
 <

 <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should participate in the action -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <
  <</role>

  <type value="[code]"/><!-- ?? 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
  <typeReference><!-- ?? 0..1 Reference(CareTeam) 
      Who or what can participate --></typeReference>
  <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
  <function><!-- ?? 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>

 </participant>
 <product[x]><!-- ?? 0..1 Reference(Medication)|CodeableConcept What's administered/supplied   --></product[x]>
 <quantity><!-- ?? 0..1 Quantity 
     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..* Reference(SpecimenDefinition) 
     What specimens are required to perform this action --></specimenRequirement>
 <observationRequirement><!-- ?? 0..* Reference(ObservationDefinition) 
     What observations are required to perform this action --></observationRequirement>
 <observationResultRequirement><!-- ?? 0..* Reference(ObservationDefinition) 
     What observations must be produced by this action --></observationResultRequirement>
 <transform value="[canonical]"/><!-- ?? 0..1 Transform to apply the template -->
 <

 <dynamicValue> ?? 0..* BackboneElement  <!-- ?? 0..* Dynamic aspects of the definition -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <

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

{ // Shareable ActivityDefinition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this activity definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the activity definition
    "version" : "<string>", // C? R! Business version of the activity definition
    "name" : "<string>", // C? R! Name for this activity definition (computer friendly)
    "title" : "<string>", // C?Name for this activity definition (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the activity definition
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage

    "
    "

// value[x]: Type of individual the activity definition is intended for. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the activity definition is intended for
    "subjectReference" : { Reference(Group) }, // C?Type of individual the activity definition is intended for
    "subjectCanonical" : "<canonical>", // C?Type of individual the activity definition is intended for

    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the activity definition
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for activity definition (if applicable)
    "purpose" : "<markdown>", // C?Why this activity definition is defined
    "usage" : "<string>", // C?Describes the clinical usage of the activity definition
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the activity definition was approved by publisher
    "lastReviewDate" : "<date>", // C?When the activity definition was last reviewed
    "effectivePeriod" : { Period }, // C?When the activity definition is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "library" : ["<canonical>"], // C?Logic used by the activity definition
    "kind" : "<code>", // C?Kind of resource
    "profile" : "<canonical>", // C?What profile the resource needs to conform to
    "code" : { CodeableConcept }, // C?Detail type of activity
    "intent" : "<code>", // C?proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // C?routine | urgent | asap | stat
    "doNotPerform" : <boolean>, // C?True if the activity should not be performed

    "
    "
    "
    "
    "
    "
    "
    "

// value[x]: When activity is to occur. One of these 4:
    "timingTiming" : { Timing }, // C?When activity is to occur
    "timingAge" : { Age }, // C?When activity is to occur
    "timingRange" : { Range }, // C?When activity is to occur
    "timingDuration" : { Duration }, // C?When activity is to occur
    "location" : { CodeableReference(Location) }, // C?Where it should happen
    "participant" : [{ BackboneElement }], // C?Who should participate in the action

// value[x]: What's administered/supplied. One of these 2:
    "productReference" : { Reference(Medication) }, // C?What's administered/supplied
    "productCodeableConcept" : { CodeableConcept }, // C?What's administered/supplied
    "
    "

    "quantity" : { Quantity(SimpleQuantity) }, // C?How much is administered/consumed/supplied
    "dosage" : [{ Dosage }] // C?Detailed dosage instructions

    "bodySite" : [{ CodeableConcept }], // C?What part of body to perform on
    "specimenRequirement" : [{ Reference(SpecimenDefinition) }], // C?What specimens are required to perform this action
    "observationRequirement" : [{ Reference(ObservationDefinition) }], // C?What observations are required to perform this action
    "observationResultRequirement" : [{ Reference(ObservationDefinition) }], // C?What observations must be produced by this action
    "transform" : "<canonical>", // C?Transform to apply the template
    "

    "dynamicValue" : [{ BackboneElement }], // C?Dynamic aspects of the definition

  }

This structure is derived from ActivityDefinition .

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Differential View

This structure is derived from ActivityDefinition .

Name Flags Card. Type Description & Constraints doco
. . ActivityDefinition 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
. . . url 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
. . . identifier S 0 .. * Identifier Additional identifier for the activity definition
. . . version 1..1 string Business version of the activity definition
. . . title S 0..1 string Name for this activity definition (human friendly)
. . . experimental 1..1 boolean For testing purposes, not real usage
. . . date S 0..1 dateTime Date last changed
. . . publisher 1..1 string Name of the publisher (organization or individual)
. . . contact S 0 .. * ContactDetail Contact details for the publisher
. . . description 1..1 markdown Natural language description of the activity definition
. . . useContext S 0 .. * UsageContext The context that the content is intended to support
. . . jurisdiction S 0 .. * CodeableConcept Intended jurisdiction for activity definition (if applicable)

doco Documentation for this format

Snapshot View

I I I I I I I I I I I I I I I I Timing timingDateTime I I I I 1..1 I I I I I I I I I I I
Name Flags Card. Type Description & Constraints doco
. . ActivityDefinition I 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages : IETF language tag

. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
. . . identifier S Σ I 0..* Identifier Additional identifier for the activity definition
. . . version Σ I 1..1 string Business version of the activity definition
. . . name Σ I 1..1 string Name for this activity definition (computer friendly)
. . . title S Σ I 0..1 string Name for this activity definition (human friendly)
. . . subtitle I 0..1 string Subordinate title of the activity definition
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ) ): The lifecycle status of an artifact.

. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . subject[x] I 0..1 Type of individual the activity definition is intended for
Binding: Subject type ( extensible ) ): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference (group.html) ( Group )
. . . . subjectCanonical canonical (Any)
. . . date S Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 string Name of the publisher (organization or individual)
. . . contact S Σ I 0..* ContactDetail Contact details for the publisher
. . . description Σ I 1..1 markdown Natural language description of the activity definition
. . . useContext S Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction S Σ I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ( extensible ) ): Countries and regions within which this artifact is targeted for use.


. . . purpose 0..1 markdown Why this activity definition is defined
. . . usage 0..1 string Describes the clinical usage of the activity definition
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . approvalDate 0..1 date When the activity definition was approved by publisher
. . . lastReviewDate 0..1 date When the activity definition was last reviewed
. . . effectivePeriod Σ I 0..1 Period When the activity definition is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic ( example ) ): High-level categorization of the definition, used for searching, sorting, and filtering.


. . . author 0..* ContactDetail Who authored the content
. . . editor 0..* ContactDetail Who edited the content
. . . reviewer 0..* ContactDetail Who reviewed the content
. . . endorser 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
. . . library 0..* canonical ( Library ) Logic used by the activity definition
. . . kind Σ I 0..1 code Kind of resource
Binding: RequestResourceType ( required ) ): The kind of activity the definition is describing.

. . . profile 0..1 canonical ( StructureDefinition ) What profile the resource needs to conform to
. . . code Σ I 0..1 CodeableConcept Detail type of activity
Binding: Procedure Codes (SNOMED CT) ( example ) ): Detailed type of the activity; e.g. CBC.

. . . intent 0..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent ( required ) ): Codes indicating the degree of authority/intentionality associated with a request.

. . . priority 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . doNotPerform ?! Σ I 0..1 boolean True if the activity should not be performed
. . . timing[x] 0..1 When activity is to occur
. . . . timingTiming dateTime Timing
. . . . timingAge Age
. . . . timingPeriod timingRange Period timingRange Range
. . . . timingDuration Duration
. . . location 0..1 Reference CodeableReference ( Location ) Where it should happen
. . . participant 0..* BackboneElement Who should participate in the action
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | related-person practitionerrole | device relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity.

.... typeReference 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) Who or what can participate
. . . . role I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: Action participant role ActionParticipantRole ( example ) ): Defines roles played by participants for the action.

. . product[x] . . function I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.
Binding: ActionParticipantFunction ( example )
... product[x] 0..1 What's administered/supplied
Binding: SNOMED CT Medication Codes ( example ) ): Code describing the type of substance or medication.

. . . . productReference Reference (medication.html ( Medication | substance.html) Substance | Ingredient )
. . . . productCodeableConcept CodeableConcept
. . . quantity 0..1 SimpleQuantity How much is administered/consumed/supplied
. . . dosage 0..* Dosage Detailed dosage instructions
. . . bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMED CT Body Structures ( example ) ): A code that identifies the anatomical location.


. . . specimenRequirement 0..* Reference ( SpecimenDefinition ) What specimens are required to perform this action
. . . observationRequirement 0..* Reference ( ObservationDefinition ) What observations are required to perform this action
. . . observationResultRequirement 0..* Reference ( ObservationDefinition ) What observations must be produced by this action
. . . transform 0..1 canonical ( StructureMap ) Transform to apply the template
. . . dynamicValue 0..* BackboneElement Dynamic aspects of the definition
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . path 1..1 string The path to the element to be set dynamically
. . . . expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

XML Template 

<!-- Shareable ActivityDefinition -->doco

<ActivityDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <

 <contained><!-- 0..* Resource 

     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..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]"/><!-- ?? 1..1 Business version of the activity definition -->
 <name value="[string]"/><!-- ?? 1..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]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <</subject[x]>

 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for   --></subject[x]>

 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..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 value="[canonical]"/><!-- ?? 0..* Logic used by the activity definition -->
 <kind value="[code]"/><!-- ?? 0..1 Kind of resource   -->
 <profile value="[canonical]"/><!-- ?? 0..1 What profile the resource needs to conform to -->
 <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]>
 <

 <timing[x]><!-- ?? 0..1 Timing|Age|Range|Duration 
     When activity is to occur --></timing[x]>
 <location><!-- ?? 0..1 CodeableReference 

     Where it should happen --></location>
 <

 <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should participate in the action -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <
  <</role>

  <type value="[code]"/><!-- ?? 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
  <typeReference><!-- ?? 0..1 Reference(CareTeam) 
      Who or what can participate --></typeReference>
  <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
  <function><!-- ?? 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>

 </participant>
 <product[x]><!-- ?? 0..1 Reference(Medication)|CodeableConcept What's administered/supplied   --></product[x]>
 <quantity><!-- ?? 0..1 Quantity 
     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..* Reference(SpecimenDefinition) 
     What specimens are required to perform this action --></specimenRequirement>
 <observationRequirement><!-- ?? 0..* Reference(ObservationDefinition) 
     What observations are required to perform this action --></observationRequirement>
 <observationResultRequirement><!-- ?? 0..* Reference(ObservationDefinition) 
     What observations must be produced by this action --></observationResultRequirement>
 <transform value="[canonical]"/><!-- ?? 0..1 Transform to apply the template -->
 <

 <dynamicValue> ?? 0..* BackboneElement  <!-- ?? 0..* Dynamic aspects of the definition -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <

  <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 

{ // Shareable ActivityDefinition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this activity definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the activity definition
    "version" : "<string>", // C? R! Business version of the activity definition
    "name" : "<string>", // C? R! Name for this activity definition (computer friendly)
    "title" : "<string>", // C?Name for this activity definition (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the activity definition
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage

    "
    "

// value[x]: Type of individual the activity definition is intended for. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the activity definition is intended for
    "subjectReference" : { Reference(Group) }, // C?Type of individual the activity definition is intended for
    "subjectCanonical" : "<canonical>", // C?Type of individual the activity definition is intended for

    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the activity definition
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for activity definition (if applicable)
    "purpose" : "<markdown>", // C?Why this activity definition is defined
    "usage" : "<string>", // C?Describes the clinical usage of the activity definition
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the activity definition was approved by publisher
    "lastReviewDate" : "<date>", // C?When the activity definition was last reviewed
    "effectivePeriod" : { Period }, // C?When the activity definition is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "library" : ["<canonical>"], // C?Logic used by the activity definition
    "kind" : "<code>", // C?Kind of resource
    "profile" : "<canonical>", // C?What profile the resource needs to conform to
    "code" : { CodeableConcept }, // C?Detail type of activity
    "intent" : "<code>", // C?proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // C?routine | urgent | asap | stat
    "doNotPerform" : <boolean>, // C?True if the activity should not be performed

    "
    "
    "
    "
    "
    "
    "
    "

// value[x]: When activity is to occur. One of these 4:
    "timingTiming" : { Timing }, // C?When activity is to occur
    "timingAge" : { Age }, // C?When activity is to occur
    "timingRange" : { Range }, // C?When activity is to occur
    "timingDuration" : { Duration }, // C?When activity is to occur
    "location" : { CodeableReference(Location) }, // C?Where it should happen
    "participant" : [{ BackboneElement }], // C?Who should participate in the action

// value[x]: What's administered/supplied. One of these 2:
    "productReference" : { Reference(Medication) }, // C?What's administered/supplied
    "productCodeableConcept" : { CodeableConcept }, // C?What's administered/supplied
    "
    "

    "quantity" : { Quantity(SimpleQuantity) }, // C?How much is administered/consumed/supplied
    "dosage" : [{ Dosage }] // C?Detailed dosage instructions

    "bodySite" : [{ CodeableConcept }], // C?What part of body to perform on
    "specimenRequirement" : [{ Reference(SpecimenDefinition) }], // C?What specimens are required to perform this action
    "observationRequirement" : [{ Reference(ObservationDefinition) }], // C?What observations are required to perform this action
    "observationResultRequirement" : [{ Reference(ObservationDefinition) }], // C?What observations must be produced by this action
    "transform" : "<canonical>", // C?Transform to apply the template
    "

    "dynamicValue" : [{ BackboneElement }], // C?Dynamic aspects of the definition

  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

12.17.11.2.2 12.21.12.2.2 Terminology Bindings

Path Name Conformance ValueSet
ActivityDefinition.language Common Languages preferred Common Languages
ActivityDefinition.status PublicationStatus required PublicationStatus
ActivityDefinition.subject[x] Subject type extensible Subject type
ActivityDefinition.jurisdiction Jurisdiction extensible Jurisdiction
ActivityDefinition.topic DefinitionTopic example DefinitionTopic
ActivityDefinition.kind RequestResourceType required RequestResourceType
ActivityDefinition.code Procedure Codes (SNOMED CT) example Procedure Codes (SNOMED CT)
ActivityDefinition.intent RequestIntent required RequestIntent
ActivityDefinition.priority Request priority RequestPriority required Request priority RequestPriority
ActivityDefinition.participant.type ActionParticipantType required ActionParticipantType
ActivityDefinition.participant.role Action participant role ActionParticipantRole example Action participant role ActionParticipantRole
ActivityDefinition.participant.function ActionParticipantFunction example ActionParticipantFunction
ActivityDefinition.product[x] SNOMED CT Medication Codes example SNOMED CT Medication Codes
ActivityDefinition.bodySite SNOMED CT Body Structures example SNOMED CT Body Structures
.