This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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
Clinical Decision Support Work Group | Maturity Level: 0 | Trial 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
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
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 indicates the differences between this profile and the base ActivityDefinition structure.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
name | 1..1 | string | Name for this activity definition (computer friendly) | |
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/steward (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) |
Documentation for this format |
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ActivityDefinition structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 1..1 | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 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 | ||||
name | ΣC | 1..1 | string | Name for this activity definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this activity definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the activity definition | |||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type 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.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
subjectCanonical | canonical(EvidenceVariable) | |||||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher/steward (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) Binding: Jurisdiction ValueSet (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 | Σ | 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 | Σ | 0..1 | code | Kind of resource Binding: Request Resource Types (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 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: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
timing[x] | 0..1 | When activity is to occur | ||||||
timingTiming | Timing | |||||||
timingAge | Age | |||||||
timingRange | Range | |||||||
timingDuration | Duration | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions 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. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
location | 0..1 | CodeableReference(Location) | Where it should happen | |||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
typeCanonical | 0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
typeReference | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
function | 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 | 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..* | 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 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 | |||||
Documentation for this format |
<!-- Shareable ActivityDefinition --> <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 --> <name value="[string]"/><!-- I 1..1 Name for this activity definition (computer friendly) --> <title value="[string]"/><!-- I 0..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 1..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="[string]"/><!-- I 0..1 Describes the clinical usage of the activity definition --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <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 --> <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. --></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>
{ // Shareable ActivityDefinition // 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 "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 "name" : "<string>", // I R! Name for this activity definition (computer friendly) "title" : "<string>", // IName 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>", // I R! Name 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" : "<string>", // IDescribes the clinical usage of the activity definition "copyright" : "<markdown>", // IUse and/or publishing restrictions "approvalDate" : "<date>", // IWhen the activity definition was approved by publisher "lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed "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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
name | 1..1 | string | Name for this activity definition (computer friendly) | |
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/steward (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) |
Documentation for this format |
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ActivityDefinition structure.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 1..1 | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 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 | ||||
name | ΣC | 1..1 | string | Name for this activity definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this activity definition (human friendly) | ||||
subtitle | 0..1 | string | Subordinate title of the activity definition | |||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | 0..1 | Type 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.). | ||||||
subjectCodeableConcept | CodeableConcept | |||||||
subjectReference | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
subjectCanonical | canonical(EvidenceVariable) | |||||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher/steward (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) Binding: Jurisdiction ValueSet (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 | Σ | 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 | Σ | 0..1 | code | Kind of resource Binding: Request Resource Types (required): The kind of activity the definition is describing. | ||||
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
code | Σ | 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: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
timing[x] | 0..1 | When activity is to occur | ||||||
timingTiming | Timing | |||||||
timingAge | Age | |||||||
timingRange | Range | |||||||
timingDuration | Duration | |||||||
asNeeded[x] | Σ | 0..1 | Preconditions 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. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
location | 0..1 | CodeableReference(Location) | Where it should happen | |||||
participant | 0..* | BackboneElement | Who should participate in the action | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
typeCanonical | 0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
typeReference | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
function | 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 | 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..* | 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 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 | |||||
Documentation for this format |
XML Template
<!-- Shareable ActivityDefinition --> <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 --> <name value="[string]"/><!-- I 1..1 Name for this activity definition (computer friendly) --> <title value="[string]"/><!-- I 0..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 1..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="[string]"/><!-- I 0..1 Describes the clinical usage of the activity definition --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <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 --> <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. --></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
{ // Shareable ActivityDefinition // 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 "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 "name" : "<string>", // I R! Name for this activity definition (computer friendly) "title" : "<string>", // IName 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>", // I R! Name 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" : "<string>", // IDescribes the clinical usage of the activity definition "copyright" : "<markdown>", // IUse and/or publishing restrictions "approvalDate" : "<date>", // IWhen the activity definition was approved by publisher "lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed "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
Path | Name | Conformance | ValueSet |
ActivityDefinition.language | Common Languages | preferred | Common Languages |
ActivityDefinition.status | PublicationStatus | required | PublicationStatus |
ActivityDefinition.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
ActivityDefinition.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
ActivityDefinition.topic | DefinitionTopic | example | DefinitionTopic |
ActivityDefinition.kind | Request Resource Types | required | Request Resource Types |
ActivityDefinition.code | Procedure Codes (SNOMED CT) | example | Procedure Codes (SNOMED CT) |
ActivityDefinition.intent | RequestIntent | required | RequestIntent |
ActivityDefinition.priority | RequestPriority | required | RequestPriority |
ActivityDefinition.asNeeded[x] | SNOMED CT Medication As Needed Reason Codes | example | SNOMED CT Medication As Needed Reason Codes |
ActivityDefinition.participant.type | ActionParticipantType | required | ActionParticipantType |
ActivityDefinition.participant.role | ActionParticipantRole | example | 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 |