Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

12.22.12.2 StructureDefinition: ShareableActivityDefinition

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

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

Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management icon implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.

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

12.22.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: 5 elements
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base ActivityDefinition structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... version S1..1stringBusiness version of the activity definition
... versionAlgorithm[x] S0..1string, CodingHow to compare versions
... name S0..1stringName for this activity definition (computer friendly)
... title S1..1stringName for this activity definition (human friendly)
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher/steward (organization or individual)
... description S1..1markdownNatural language description of the activity definition

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ActivityDefinition structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C icon1..1ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version SΣ1..1stringBusiness version of the activity definition
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this activity definition (computer friendly)
... title SΣ1..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... 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
Binding: Request Resource Types (required): The kind of activity the definition is describing.

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

... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... 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
Binding: SNOMED CT Medication As Needed Reason Codes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (required): The type of participant in the activity.

.... 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
Binding: Action Participant Role icon (example): Defines roles played by participants for the action.

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

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMED CT Body Structures (example): A code that identifies the anatomical location.


... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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 icon
<!-- ShareableActivityDefinition -->doco

<ActivityDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 
     Canonical identifier for this activity definition, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the activity definition --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the activity definition -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this activity definition (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this activity definition (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the activity definition -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for   --></subject[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the activity definition -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this activity definition is defined -->
 <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the activity definition -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the activity definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the activity definition was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the activity definition is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail 
     Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail 
     Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail 
     Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail 
     Who endorsed the content --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <library value="[canonical]"/><!-- I 0..* Logic used by the activity definition -->
 <kind value="[code]"/><!-- I 0..1 Kind of resource   -->
 <profile value="[canonical]"/><!-- I 0..1 What profile the resource needs to conform to -->
 <code><!-- I 0..1 CodeableConcept Detail type of activity   --></code>
 <intent value="[code]"/><!-- I 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option   -->
 <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
 <doNotPerform value="[boolean]"/><!-- I 0..1 True if the activity should not be performed -->
 <timing[x]><!-- I 0..1 Timing|Age|Range|Duration 
     When activity is to occur --></timing[x]>
 <asNeeded[x]><!-- I 0..1 boolean|CodeableConcept Preconditions for service   --></asNeeded[x]>
 <location><!-- I 0..1 CodeableReference 
     Where it should happen --></location>
 <participant> I 0..* BackboneElement  <!-- I 0..* Who should participate in the action -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
  <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
  <typeReference><!-- I 0..1 Reference(CareTeam) 
      Who or what can participate --></typeReference>
  <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc icon   --></role>
  <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc   --></function>
 </participant>
 <product[x]><!-- I 0..1 Reference(Medication)|CodeableConcept What's administered/supplied   --></product[x]>
 <quantity><!-- I 0..1 Quantity 
     How much is administered/consumed/supplied --></quantity>
 <dosage><!-- I 0..* Dosage Detailed dosage instructions --></dosage>
 <bodySite><!-- I 0..* CodeableConcept What part of body to perform on   --></bodySite>
 <specimenRequirement value="[canonical]"/><!-- I 0..* What specimens are required to perform this action -->
 <observationRequirement value="[canonical]"/><!-- I 0..* What observations are required to perform this action -->
 <observationResultRequirement value="[canonical]"/><!-- I 0..* What observations must be produced by this action -->
 <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template -->
 <dynamicValue> I 0..* BackboneElement  <!-- I 0..* Dynamic aspects of the definition -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <path value="[string]"/><!-- I 1..1 The path to the element to be set dynamically -->
  <expression><!-- I 1..1 Expression 
      An expression that provides the dynamic value for the customization --></expression>
 </dynamicValue>
</ActivityDefinition>

{ // ShareableActivityDefinition
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this activity definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the activity definition
    "version" : "<string>", // I R! Business version of the activity definition
  // value[x]: How to compare versions. One of these 2:
    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this activity definition (computer friendly)
    "title" : "<string>", // I R! Name for this activity definition (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the activity definition
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
  // value[x]: Type of individual the activity definition is intended for. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept }, // IType of individual the activity definition is intended for
    "subjectReference" : { Reference(Group) }, // IType of individual the activity definition is intended for
    "subjectCanonical" : "<canonical>", // IType of individual the activity definition is intended for
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the activity definition
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for activity definition (if applicable)
    "purpose" : "<markdown>", // IWhy this activity definition is defined
    "usage" : "<markdown>", // IDescribes the clinical usage of the activity definition
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the activity definition was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the activity definition is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "library" : ["<canonical>"], // ILogic used by the activity definition
    "kind" : "<code>", // IKind of resource
    "profile" : "<canonical>", // IWhat profile the resource needs to conform to
    "code" : { CodeableConcept }, // IDetail type of activity
    "intent" : "<code>", // Iproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // Iroutine | urgent | asap | stat
    "doNotPerform" : <boolean>, // ITrue if the activity should not be performed
  // value[x]: When activity is to occur. One of these 4:
    "timingTiming" : { Timing }, // IWhen activity is to occur
    "timingAge" : { Age }, // IWhen activity is to occur
    "timingRange" : { Range }, // IWhen activity is to occur
    "timingDuration" : { Duration }, // IWhen activity is to occur
  // value[x]: Preconditions for service. One of these 2:
    "asNeededBoolean" : <boolean>, // IPreconditions for service
    "asNeededCodeableConcept" : { CodeableConcept }, // IPreconditions for service
    "location" : { CodeableReference(Location) }, // IWhere it should happen
    "participant" : [{ BackboneElement }], // IWho should participate in the action
  // value[x]: What's administered/supplied. One of these 2:
    "productReference" : { Reference(Medication) }, // IWhat's administered/supplied
    "productCodeableConcept" : { CodeableConcept }, // IWhat's administered/supplied
    "quantity" : { Quantity(SimpleQuantity) }, // IHow much is administered/consumed/supplied
    "dosage" : [{ Dosage }], // IDetailed dosage instructions
    "bodySite" : [{ CodeableConcept }], // IWhat part of body to perform on
    "specimenRequirement" : ["<canonical>"], // IWhat specimens are required to perform this action
    "observationRequirement" : ["<canonical>"], // IWhat observations are required to perform this action
    "observationResultRequirement" : ["<canonical>"], // IWhat observations must be produced by this action
    "transform" : "<canonical>", // ITransform to apply the template
    "dynamicValue" : [{ BackboneElement }], // IDynamic aspects of the definition
  }

This structure is derived from ActivityDefinition.

Differential View

This indicates the differences between this profile and the base ActivityDefinition structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... version S1..1stringBusiness version of the activity definition
... versionAlgorithm[x] S0..1string, CodingHow to compare versions
... name S0..1stringName for this activity definition (computer friendly)
... title S1..1stringName for this activity definition (human friendly)
... experimental S1..1booleanFor testing purposes, not real usage
... publisher S0..1stringName of the publisher/steward (organization or individual)
... description S1..1markdownNatural language description of the activity definition

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ActivityDefinition structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C icon1..1ActivityDefinitionThe definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: All Languages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the activity definition
... version SΣ1..1stringBusiness version of the activity definition
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this activity definition (computer friendly)
... title SΣ1..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonicalcanonical(EvidenceVariable)
... date Σ0..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the activity definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this activity definition is defined
... usage 0..1markdownDescribes the clinical usage of the activity definition
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the activity definition was approved by publisher
... lastReviewDate 0..1dateWhen the activity definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the activity definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... 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
Binding: Request Resource Types (required): The kind of activity the definition is describing.

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

... intent 0..1codeproposal | 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..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... 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
Binding: SNOMED CT Medication As Needed Reason Codes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... location 0..1CodeableReference(Location)Where it should happen
... participant 0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (required): The type of participant in the activity.

.... 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
Binding: Action Participant Role icon (example): Defines roles played by participants for the action.

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

.... productReferenceReference(Medication | Ingredient | Substance | SubstanceDefinition)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMED CT Body Structures (example): A code that identifies the anatomical location.


... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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 icon

XML Template

<!-- ShareableActivityDefinition -->doco

<ActivityDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 
     Canonical identifier for this activity definition, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the activity definition --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the activity definition -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this activity definition (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this activity definition (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the activity definition -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for   --></subject[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the activity definition -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this activity definition is defined -->
 <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the activity definition -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the activity definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the activity definition was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the activity definition is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail 
     Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail 
     Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail 
     Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail 
     Who endorsed the content --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <library value="[canonical]"/><!-- I 0..* Logic used by the activity definition -->
 <kind value="[code]"/><!-- I 0..1 Kind of resource   -->
 <profile value="[canonical]"/><!-- I 0..1 What profile the resource needs to conform to -->
 <code><!-- I 0..1 CodeableConcept Detail type of activity   --></code>
 <intent value="[code]"/><!-- I 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option   -->
 <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
 <doNotPerform value="[boolean]"/><!-- I 0..1 True if the activity should not be performed -->
 <timing[x]><!-- I 0..1 Timing|Age|Range|Duration 
     When activity is to occur --></timing[x]>
 <asNeeded[x]><!-- I 0..1 boolean|CodeableConcept Preconditions for service   --></asNeeded[x]>
 <location><!-- I 0..1 CodeableReference 
     Where it should happen --></location>
 <participant> I 0..* BackboneElement  <!-- I 0..* Who should participate in the action -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
  <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
  <typeReference><!-- I 0..1 Reference(CareTeam) 
      Who or what can participate --></typeReference>
  <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc icon   --></role>
  <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc   --></function>
 </participant>
 <product[x]><!-- I 0..1 Reference(Medication)|CodeableConcept What's administered/supplied   --></product[x]>
 <quantity><!-- I 0..1 Quantity 
     How much is administered/consumed/supplied --></quantity>
 <dosage><!-- I 0..* Dosage Detailed dosage instructions --></dosage>
 <bodySite><!-- I 0..* CodeableConcept What part of body to perform on   --></bodySite>
 <specimenRequirement value="[canonical]"/><!-- I 0..* What specimens are required to perform this action -->
 <observationRequirement value="[canonical]"/><!-- I 0..* What observations are required to perform this action -->
 <observationResultRequirement value="[canonical]"/><!-- I 0..* What observations must be produced by this action -->
 <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template -->
 <dynamicValue> I 0..* BackboneElement  <!-- I 0..* Dynamic aspects of the definition -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <path value="[string]"/><!-- I 1..1 The path to the element to be set dynamically -->
  <expression><!-- I 1..1 Expression 
      An expression that provides the dynamic value for the customization --></expression>
 </dynamicValue>
</ActivityDefinition>

JSON Template

{ // ShareableActivityDefinition
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this activity definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the activity definition
    "version" : "<string>", // I R! Business version of the activity definition
  // value[x]: How to compare versions. One of these 2:
    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this activity definition (computer friendly)
    "title" : "<string>", // I R! Name for this activity definition (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the activity definition
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
  // value[x]: Type of individual the activity definition is intended for. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept }, // IType of individual the activity definition is intended for
    "subjectReference" : { Reference(Group) }, // IType of individual the activity definition is intended for
    "subjectCanonical" : "<canonical>", // IType of individual the activity definition is intended for
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the activity definition
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for activity definition (if applicable)
    "purpose" : "<markdown>", // IWhy this activity definition is defined
    "usage" : "<markdown>", // IDescribes the clinical usage of the activity definition
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the activity definition was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the activity definition is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "library" : ["<canonical>"], // ILogic used by the activity definition
    "kind" : "<code>", // IKind of resource
    "profile" : "<canonical>", // IWhat profile the resource needs to conform to
    "code" : { CodeableConcept }, // IDetail type of activity
    "intent" : "<code>", // Iproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // Iroutine | urgent | asap | stat
    "doNotPerform" : <boolean>, // ITrue if the activity should not be performed
  // value[x]: When activity is to occur. One of these 4:
    "timingTiming" : { Timing }, // IWhen activity is to occur
    "timingAge" : { Age }, // IWhen activity is to occur
    "timingRange" : { Range }, // IWhen activity is to occur
    "timingDuration" : { Duration }, // IWhen activity is to occur
  // value[x]: Preconditions for service. One of these 2:
    "asNeededBoolean" : <boolean>, // IPreconditions for service
    "asNeededCodeableConcept" : { CodeableConcept }, // IPreconditions for service
    "location" : { CodeableReference(Location) }, // IWhere it should happen
    "participant" : [{ BackboneElement }], // IWho should participate in the action
  // value[x]: What's administered/supplied. One of these 2:
    "productReference" : { Reference(Medication) }, // IWhat's administered/supplied
    "productCodeableConcept" : { CodeableConcept }, // IWhat's administered/supplied
    "quantity" : { Quantity(SimpleQuantity) }, // IHow much is administered/consumed/supplied
    "dosage" : [{ Dosage }], // IDetailed dosage instructions
    "bodySite" : [{ CodeableConcept }], // IWhat part of body to perform on
    "specimenRequirement" : ["<canonical>"], // IWhat specimens are required to perform this action
    "observationRequirement" : ["<canonical>"], // IWhat observations are required to perform this action
    "observationResultRequirement" : ["<canonical>"], // IWhat observations must be produced by this action
    "transform" : "<canonical>", // ITransform to apply the template
    "dynamicValue" : [{ BackboneElement }], // IDynamic aspects of the definition
  }

 

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

12.22.12.2.2 Terminology Bindings

PathNameConformanceValueSet
ActivityDefinition.languageAll LanguagesrequiredAll Languages
ActivityDefinition.versionAlgorithm[x]Version AlgorithmextensibleVersion Algorithm
ActivityDefinition.statusPublicationStatusrequiredPublicationStatus
ActivityDefinition.subject[x]Participant Resource TypesextensibleParticipant Resource Types
ActivityDefinition.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
ActivityDefinition.topicDefinition TopicexampleDefinition Topic
ActivityDefinition.kindRequest Resource TypesrequiredRequest Resource Types
ActivityDefinition.codeProcedure Codes (SNOMED CT)exampleProcedure Codes (SNOMED CT)
ActivityDefinition.intentRequestIntentrequiredRequestIntent
ActivityDefinition.priorityRequestPriorityrequiredRequestPriority
ActivityDefinition.asNeeded[x]SNOMED CT Medication As Needed Reason CodesexampleSNOMED CT Medication As Needed Reason Codes
ActivityDefinition.participant.typeAction Participant TyperequiredAction Participant Type
ActivityDefinition.participant.roleAction Participant RoleexampleAction Participant Role icon
ActivityDefinition.participant.functionAction Participant FunctionexampleAction Participant Function
ActivityDefinition.product[x]SNOMED CT Medication CodesexampleSNOMED CT Medication Codes
ActivityDefinition.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
. .