Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot3 - STU 1 Ballot 3 World

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: RecommendationAction

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/recommendation-action Version: 1.0.0-ballot3
Standards status: Trial-use Maturity Level: 1 Computable Name: RecommendationAction
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.78

Profile of ActivityDefinition for Evidence Based Medicine IG. The RecommendationAction Profile is used for a recommendation from a clinical practice guideline.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ActivityDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.topic 0..0 E.g. Education, Treatment, Assessment, etc

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0
ActivityDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ActivityDefinition.url This element is included in summaries. C 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
Constraints: cnl-1
ActivityDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.version This element is included in summaries. 0..1 string Business version of the activity definition
ActivityDefinition.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ActivityDefinition.versionAlgorithm[x].versionAlgorithmString string
ActivityDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
ActivityDefinition.name This element is included in summaries. C 0..1 string Name for this activity definition (computer friendly)
ActivityDefinition.title This element is included in summaries. 0..1 string Name for this activity definition (human friendly)
ActivityDefinition.subtitle 0..1 string Subordinate title of the activity definition
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.experimental This element is included in summaries. 0..1 boolean For testing only - never for real usage
ActivityDefinition.subject[x] 0..1 Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
ActivityDefinition.subject[x].subjectCanonical canonical(EvidenceVariable)
ActivityDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
ActivityDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
ActivityDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the activity definition
ActivityDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Jurisdiction of the authority that maintains the activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ActivityDefinition.purpose 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 markdown Describes the clinical usage of the activity definition
ActivityDefinition.copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
ActivityDefinition.copyrightLabel 0..1 string Copyright holder and year(s)
ActivityDefinition.approvalDate 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate 0..1 date When the activity definition was last reviewed by the publisher
ActivityDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.author 0..* ContactDetail Who authored the content
ActivityDefinition.editor 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact C 0..* RelatedArtifact Additional documentation, citations, etc
Constraints: adf-2, adf-3
ActivityDefinition.library 0..* canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element is included in summaries. 0..1 code Kind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.
ActivityDefinition.profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
ActivityDefinition.code This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
ActivityDefinition.intent 0..1 code proposal | solicit-offer | offer-response | 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.
ActivityDefinition.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.timing[x].timingRelativeTime RelativeTime
ActivityDefinition.asNeeded[x] This element is included in summaries. 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
ActivityDefinition.asNeeded[x].asNeededBoolean boolean
ActivityDefinition.asNeeded[x].asNeededCodeableConcept CodeableConcept
ActivityDefinition.location 0..1 CodeableReference(Location) Where it should happen
ActivityDefinition.participant 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.participant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
ActivityDefinition.participant.type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.participant.typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
ActivityDefinition.participant.typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
ActivityDefinition.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.
ActivityDefinition.participant.function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunctionExample (example)
ActivityDefinition.product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
ActivityDefinition.product[x].productReference Reference(Medication | MedicinalProductDefinition | Ingredient | SubstanceDefinition)
ActivityDefinition.product[x].productCodeableConcept CodeableConcept
ActivityDefinition.quantity C 0..1 SimpleQuantity(6.0.0-snapshot1) How much is administered/consumed/supplied
Constraints: sqty-1
ActivityDefinition.dosageInstruction 0..1 DosageDetails Detailed dosage instructions
ActivityDefinition.bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
ActivityDefinition.specimenRequirement 0..* canonical(SpecimenDefinition) What specimens are required to perform this action
ActivityDefinition.observationRequirement 0..* canonical(ObservationDefinition) What observations are required to perform this action
ActivityDefinition.observationResultRequirement 0..* canonical(ObservationDefinition) What observations must be produced by this action
ActivityDefinition.transform 0..1 canonical() Transform to apply the template
ActivityDefinition.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.dynamicValue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
ActivityDefinition.dynamicValue.path 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Participant Resource Types 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.5
ActivityDefinition.kind Base required Request Resource Types 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.priority Base required RequestPriority 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.participant.​type Base required Action Participant Type 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.participant.​role Base example Action Participant Role 📦2.0.0 THO v7.5
ActivityDefinition.participant.​function Base example Action Participant Function Example 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-2 warning ActivityDefinition.relatedArtifact Dependencies of an ActivityDefinition should reference a resource type in ('depends-on' | 'part-of') implies ((resource.exists() xor resourceReference.exists()))
adf-3 warning ActivityDefinition.relatedArtifact ActivityDefinition should not have components type != 'composed-of'
cnl-0 warning ActivityDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ActivityDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ActivityDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.topic 0..0 E.g. Education, Treatment, Assessment, etc

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0
ActivityDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.Slices for extension.extension:timingRelativeTime 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
ActivityDefinition.Slices for extension.extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
ActivityDefinition.Slices for extension.extension:citeAs 0..1 markdown PublicationRecord for this Resource
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/cite-as
ActivityDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ActivityDefinition.url This element is included in summaries. C 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
Constraints: cnl-1
ActivityDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.version This element is included in summaries. 0..1 string Business version of the activity definition
ActivityDefinition.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ActivityDefinition.versionAlgorithm[x].versionAlgorithmString string
ActivityDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
ActivityDefinition.name This element is included in summaries. C 0..1 string Name for this activity definition (computer friendly)
ActivityDefinition.title This element is included in summaries. 0..1 string Name for this activity definition (human friendly)
ActivityDefinition.subtitle 0..1 string Subordinate title of the activity definition
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.experimental This element is included in summaries. 0..1 boolean For testing only - never for real usage
ActivityDefinition.subject[x] 0..1 Type of individual the activity definition is intended for
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
ActivityDefinition.subject[x].subjectCanonical canonical(EvidenceVariable)
ActivityDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
ActivityDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
ActivityDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the activity definition
ActivityDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Jurisdiction of the authority that maintains the activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ActivityDefinition.purpose 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 markdown Describes the clinical usage of the activity definition
ActivityDefinition.copyright 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
ActivityDefinition.copyrightLabel 0..1 string Copyright holder and year(s)
ActivityDefinition.approvalDate 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate 0..1 date When the activity definition was last reviewed by the publisher
ActivityDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.author 0..* ContactDetail Who authored the content
ActivityDefinition.editor 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact C 0..* RelatedArtifact Additional documentation, citations, etc
Constraints: adf-2, adf-3
ActivityDefinition.library 0..* canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element is included in summaries. 0..1 code Kind of resource
Binding: RequestResourceTypes (required): The kind of activity the definition is describing.
ActivityDefinition.profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
ActivityDefinition.code This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC.
ActivityDefinition.intent 0..1 code proposal | solicit-offer | offer-response | 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.
ActivityDefinition.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.timing[x].timingRelativeTime RelativeTime
ActivityDefinition.asNeeded[x] This element is included in summaries. 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
ActivityDefinition.asNeeded[x].asNeededBoolean boolean
ActivityDefinition.asNeeded[x].asNeededCodeableConcept CodeableConcept
ActivityDefinition.location 0..1 CodeableReference(Location) Where it should happen
ActivityDefinition.participant 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.participant.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
ActivityDefinition.participant.type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.participant.typeCanonical 0..1 canonical(ActorDefinition | CapabilityStatement | DeviceDefinition | Group | SpecimenDefinition | StructureDefinition) Who or what can participate
ActivityDefinition.participant.typeReference 0..1 Reference(BiologicallyDerivedProduct | CareTeam | Device | Endpoint | HealthcareService | Location | Medication | MedicinalProductDefinition | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen | Substance | SubstanceDefinition) Who or what can participate
ActivityDefinition.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
Binding: Action Participant Role (example): Defines roles played by participants for the action.
ActivityDefinition.participant.function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunctionExample (example)
ActivityDefinition.product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
ActivityDefinition.product[x].productReference Reference(Medication | MedicinalProductDefinition | Ingredient | SubstanceDefinition)
ActivityDefinition.product[x].productCodeableConcept CodeableConcept
ActivityDefinition.quantity C 0..1 SimpleQuantity(6.0.0-snapshot1) How much is administered/consumed/supplied
Constraints: sqty-1
ActivityDefinition.dosageInstruction 0..1 DosageDetails Detailed dosage instructions
ActivityDefinition.bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
ActivityDefinition.specimenRequirement 0..* canonical(SpecimenDefinition) What specimens are required to perform this action
ActivityDefinition.observationRequirement 0..* canonical(ObservationDefinition) What observations are required to perform this action
ActivityDefinition.observationResultRequirement 0..* canonical(ObservationDefinition) What observations must be produced by this action
ActivityDefinition.transform 0..1 canonical() Transform to apply the template
ActivityDefinition.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.dynamicValue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
ActivityDefinition.dynamicValue.path 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Participant Resource Types 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.5
ActivityDefinition.kind Base required Request Resource Types 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.priority Base required RequestPriority 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.participant.​type Base required Action Participant Type 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.participant.​role Base example Action Participant Role 📦2.0.0 THO v7.5
ActivityDefinition.participant.​function Base example Action Participant Function Example 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍6.0.0-snapshot1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
adf-2 warning ActivityDefinition.relatedArtifact Dependencies of an ActivityDefinition should reference a resource type in ('depends-on' | 'part-of') implies ((resource.exists() xor resourceReference.exists()))
adf-3 warning ActivityDefinition.relatedArtifact ActivityDefinition should not have components type != 'composed-of'
cnl-0 warning ActivityDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning ActivityDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron