Clinical Practice Guidelines (CPG) on EBMonFHIR
1.0.2 - qa-preview
This page is part of the CPG-on-EBMonFHIR Implementation Guide (1.0.2).
Defining URL: | https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/recommendation-action |
Version: | 0.1.1 |
Name: | RecommendationAction |
Title: | Recommendation Action |
Status: | Draft as of 2021-12-03 |
Definition: | Definition of an activity that is part of an intervention in the context of a clinical practice guideline recommendation. |
Publisher: | Netzwerk Universitätsmedizin (NUM), |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/recommendation-action
This profile defines a specific recommended activity as part of an intervention recommended by a specific Recommendation.
The actions defined using this profile are combined to a plan using the Recommendation Plan profile.
The following profiles are used to define specific actions:
The RelativeTime datatype can be used via the RelativeTime extension to define the timing of the action.
This Implementation guide has a modified interpretation of the Timing
datatype. Specifically, fields that have corresponding “Max” fields (count
, duration
, frequency
, period
) are now interpreted as minimum values. To specify an exact value, the base field and its corresponding Max
field must be set to the same value.
These changes pertain to the following profiles / elements:
Changes to Timing Datatype
Field | Description | Example |
---|---|---|
count | Minimal number of times this event should be repeated. | count: 2 means the event should occur at least 2 times. |
countMax | Maximum number of times this event should be repeated. | countMax: 5 means the event should occur no more than 5 times. |
duration | Minimal duration this event should last. | duration: 1 (assuming units are hours) means the event should last at least 1 hour. |
durationMax | Maximal duration this event should last. | durationMax: 3 (assuming units are hours) means the event should last no more than 3 hours. |
frequency | Indicates the minimal number of repetitions that should occur within a period. | frequency: 1 means the event should occur at least once per period. |
frequencyMax | Indicates the maximum number of repetitions that should occur within a period. | frequencyMax: 4 means the event should occur no more than four times per period. |
period | The minimal duration to which the frequency applies. | period: 1 (assuming units are days) means the frequency applies to at least 1 day. |
periodMax | The maximum duration to which the frequency applies. | periodMax: 7 (assuming units are days) means the frequency applies to no more than 7 days. |
Examples
{
"repeat": {
"count": 2,
"countMax": 2
}
}
{
"repeat": {
"count": 2,
"countMax": 5
}
}
{
"repeat": {
"duration": 1,
"durationUnit": "h"
}
}
{
"repeat": {
"durationMax": 2,
"durationUnit": "h"
}
}
Implementation Notes
This profile of a FHIR ActivityDefinition is derived from the cpg-computableactivity FHIR resource.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ActivityDefinition | C | 1..1 | CPGComputableActivityDefinition | This is an abstractprofile. Childprofiles: AssessmentAction, BodyPositioningAction, DrugAdministrationAction, ProcedureAction The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation no-timing-if-dosage-specified: If a dosage is specified, there SHALL be no timing element at the same level (instead the timing element of dosage should be used) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
knowledgeCapability | S | 1..1 | (Complex) | shareable | computable | publishable | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability" | |||||
value[x] | 1..1 | code | Value of extension Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact Required Pattern: computable | |||||
knowledgeRepresentationLevel | S | 1..1 | (Complex) | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel" | |||||
value[x] | 1..1 | code | Value of extension Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact Required Pattern: structured | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | SΣ | 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: publication-status|4.0.1 (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
subject[x] | S | 1..1 | CodeableConcept | Type of individual the activity definition is intended for Binding: subject-type (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/fhir-types | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
date | SΣ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | Σ | 1..1 | markdown | Natural language description of the activity definition | ||||
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: JurisdictionValueSet (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 | S | 0..1 | canonical(Library) | Logic used by the activity definition | ||||
kind | SΣ | 1..1 | code | Kind of resource Binding: request-resource-types|4.0.1 (required): The kind of activity the definition is describing. | ||||
profile | S | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | ||||
code | SΣ | 1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (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: request-intent|4.0.1 (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: request-priority|4.0.1 (required): Identifies the level of importance to be assigned to actioning the request. | |||||
doNotPerform | ?!SΣ | 0..1 | boolean | True if the activity should not be performed | ||||
timing[x] | SC | 0..1 | Timing | When activity is to occur code-xor-repeat: Either a code or a repeat structure should be defined, but not both | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relativeTime | 0..* | (Complex) | Timing in which the characteristic is determined URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/relative-time | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | SΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
count | ΣC | 0..1 | positiveInt | Minimal number of times this event should be repeated | ||||
countMax | ΣC | 0..1 | positiveInt | Maximum number of times this event should be repeated | ||||
duration | ΣC | 0..1 | decimal | Minimal duration this event should last | ||||
durationMax | ΣC | 0..1 | decimal | Maximal duration this event should last | ||||
durationUnit | ΣC | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
frequency | Σ | 0..1 | positiveInt | Indicates the minimal number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Indicates the maximum number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | ||||
period | ΣC | 0..1 | decimal | The minimal duration to which the frequency applies. I.e. Event occurs frequency times per period | ||||
periodMax | ΣC | 0..1 | decimal | The maximum duration to which the frequency applies. I.e. Event occurs frequency times per period | ||||
periodUnit | ΣC | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | ΣC | 0..* | time | Time of day for action | ||||
when | ΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real-world event relating to the schedule. | ||||
offset | ΣC | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | C | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
location | S | 0..1 | Reference(Location) | Where it should happen | ||||
participant | S | 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 | 1..1 | code | patient | practitioner | related-person | device Binding: action-participant-type|4.0.1 (required): The type of participant in the activity. | |||||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: action-participant-role (example): Defines roles played by participants for the action. | |||||
product[x] | S | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | |||||
productReference | Reference(Medication | Substance) | |||||||
productCodeableConcept | CodeableConcept | |||||||
quantity | S | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | ||||
dosage | S | 0..* | Dosage | Detailed dosage instructions | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | ΣC | 0..1 | Timing | When medication should be administered code-xor-repeat: Either a code or a repeat structure should be defined, but not both | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | SΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
count | ΣC | 0..1 | positiveInt | Minimal number of times this event should be repeated | ||||
countMax | ΣC | 0..1 | positiveInt | Maximum number of times this event should be repeated | ||||
duration | ΣC | 0..1 | decimal | Minimal duration this event should last | ||||
durationMax | ΣC | 0..1 | decimal | Maximal duration this event should last | ||||
durationUnit | ΣC | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
frequency | Σ | 0..1 | positiveInt | Indicates the minimal number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Indicates the maximum number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | ||||
period | ΣC | 0..1 | decimal | The minimal duration to which the frequency applies. I.e. Event occurs frequency times per period | ||||
periodMax | ΣC | 0..1 | decimal | The maximum duration to which the frequency applies. I.e. Event occurs frequency times per period | ||||
periodUnit | ΣC | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | ΣC | 0..* | time | Time of day for action | ||||
when | ΣC | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real-world event relating to the schedule. | ||||
offset | ΣC | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | C | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
asNeeded | ΣC | 0..1 | boolean | Take "as needed" | ||||
asNeededFor | ΣC | 0..* | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered, to be administered or typical amount to be administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
dose[x] | Σ | 0..1 | Amount of medication per dose | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
maxDosePerPeriod | Σ | 0..* | Ratio | Upper limit on medication per unit of time | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
bodySite | S | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | ||||
specimenRequirement | 0..* | Reference(SpecimenDefinition) | What specimens are required to perform this action | |||||
observationRequirement | 0..* | Reference(ObservationDefinition) | What observations are required to perform this action | |||||
observationResultRequirement | 0..* | Reference(ObservationDefinition) | What observations must be produced by this action | |||||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
dynamicValue | S | 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 | S | 1..1 | string | The path to the element to be set dynamically | ||||
expression | S | 1..1 | Expression | An expression that provides the dynamic value for the customization | ||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | 1..1 | CPGComputableActivityDefinition | This is an abstractprofile. Childprofiles: AssessmentAction, BodyPositioningAction, DrugAdministrationAction, ProcedureAction The definition of a specific activity to be taken, independent of any particular patient or context | |
meta | Σ | 1..1 | Meta | Metadata about the resource |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
Slices for extension | Content/Rules for all slices | |||
knowledgeCapability | 1..1 | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability Binding: CPG Knowledge Capability (required): A knowledge capability provided by a knowledge artifact | |
knowledgeRepresentationLevel | 1..1 | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeRepresentationLevel Binding: CPG Knowledge Representation Level (required): A level of knowledge representation provided by this artifact | |
url | Σ | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the activity definition |
title | Σ | 0..1 | string | Name for this activity definition (human friendly) |
subject[x] | 1..1 | CodeableConcept | Type of individual the activity definition is intended for Binding: subject-type (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient | |
date | Σ | 0..1 | dateTime | Date last changed |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
library | 0..1 | canonical(Library) | Logic used by the activity definition | |
kind | Σ | 1..1 | code | Kind of resource Binding: request-resource-types|4.0.1 (required): The kind of activity the definition is describing. |
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |
code | Σ | 1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodesSNOMEDCT (example): Detailed type of the activity; e.g. CBC. |
doNotPerform | ?!Σ | 0..1 | boolean | True if the activity should not be performed |
timing[x] | C | 0..1 | Timing | When activity is to occur code-xor-repeat: Either a code or a repeat structure should be defined, but not both |
repeat | ΣC | 1..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
location | 0..1 | Reference(Location) | Where it should happen | |
participant | 0..* | BackboneElement | Who should participate in the action | |
product[x] | 0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||
productReference | Reference(Medication | Substance) | |||
productCodeableConcept | CodeableConcept | |||
quantity | 0..1 | SimpleQuantity | How much is administered/consumed/supplied | |
dosage | 0..* | Dosage | Detailed dosage instructions | |
timing | Σ | 0..1 | Timing | When medication should be administered |
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
bodySite | 0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |
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 |
This structure is derived from CPGComputableActivityDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ActivityDefinition | C | 1..1 | CPGComputableActivityDefinition | This is an abstractprofile. Childprofiles: AssessmentAction, BodyPositioningAction, DrugAdministrationAction, ProcedureAction The definition of a specific activity to be taken, independent of any particular patient or context no-timing-if-dosage-specified: If a dosage is specified, there SHALL be no timing element at the same level (instead the timing element of dosage should be used) |
meta | S | 1..1 | Meta | Metadata about the resource |
source | S | 0..1 | uri | Identifies where the resource comes from |
profile | S | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
extension | 2..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:knowledgeCapability | 1..1 | CPGKnowledgeCapability | shareable | computable | publishable | executable | |
extension | 0..0 | |||
value[x] | 1..1 | code | Value of extension Required Pattern: computable | |
extension:knowledgeRepresentationLevel | 1..1 | CPGKnowledgeCapability | narrative | semi-structured | structured | executable | |
extension | 0..0 | |||
value[x] | 1..1 | code | Value of extension Required Pattern: structured | |
url | S | 1..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
subject[x] | 1..1 | CodeableConcept | Type of individual the activity definition is intended for Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient | |
code | 1..1 | CodeableConcept | Detail type of activity | |
doNotPerform | S | 0..1 | boolean | True if the activity should not be performed |
timing[x] | C | 0..1 | Timing | When activity is to occur code-xor-repeat: Either a code or a repeat structure should be defined, but not both |
Slices for extension | Content/Rules for all slices | |||
relativeTime | 0..* | (Complex) | Timing in which the characteristic is determined URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/relative-time | |
repeat | S | 1..1 | Element | When the event is to occur |
bounds[x] | 0..0 | |||
count | 0..1 | positiveInt | Minimal number of times this event should be repeated | |
countMax | 0..1 | positiveInt | Maximum number of times this event should be repeated | |
duration | 0..1 | decimal | Minimal duration this event should last | |
durationMax | 0..1 | decimal | Maximal duration this event should last | |
frequency | 0..1 | positiveInt | Indicates the minimal number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | |
frequencyMax | 0..1 | positiveInt | Indicates the maximum number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | |
period | 0..1 | decimal | The minimal duration to which the frequency applies. I.e. Event occurs frequency times per period | |
periodMax | 0..1 | decimal | The maximum duration to which the frequency applies. I.e. Event occurs frequency times per period | |
product[x] | S | 0..1 | Reference(Medication | Substance), CodeableConcept | What's administered/supplied |
quantity | S | 0..1 | SimpleQuantity | How much is administered/consumed/supplied |
dosage | S | 0..* | Dosage | Detailed dosage instructions |
timing | C | 0..1 | Timing | When medication should be administered code-xor-repeat: Either a code or a repeat structure should be defined, but not both |
repeat | S | 0..1 | Element | When the event is to occur |
bounds[x] | 0..0 | |||
count | 0..1 | positiveInt | Minimal number of times this event should be repeated | |
countMax | 0..1 | positiveInt | Maximum number of times this event should be repeated | |
duration | 0..1 | decimal | Minimal duration this event should last | |
durationMax | 0..1 | decimal | Maximal duration this event should last | |
frequency | 0..1 | positiveInt | Indicates the minimal number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | |
frequencyMax | 0..1 | positiveInt | Indicates the maximum number of repetitions that should occur within a period. I.e. Event occurs frequency times per period | |
period | 0..1 | decimal | The minimal duration to which the frequency applies. I.e. Event occurs frequency times per period | |
periodMax | 0..1 | decimal | The maximum duration to which the frequency applies. I.e. Event occurs frequency times per period | |
bodySite | S | 0..* | CodeableConcept | What part of body to perform on |
Documentation for this format |
This structure is derived from CPGComputableActivityDefinition
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code | URI | |||
ActivityDefinition.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ActivityDefinition.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
ActivityDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ActivityDefinition.extension:knowledgeCapability.value[x] | required | Pattern: computablehttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-capability | ||||
ActivityDefinition.extension:knowledgeRepresentationLevel.value[x] | required | Pattern: structuredhttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-representation-level | ||||
ActivityDefinition.status | required | http://hl7.org/fhir/ValueSet/publication-status|4.0.1http://hl7.org/fhir/ValueSet/publication-status|4.0.1 | ||||
ActivityDefinition.subject[x] | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/subject-type | ||||
ActivityDefinition.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ActivityDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
ActivityDefinition.kind | required | http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1 | ||||
ActivityDefinition.code | example | ProcedureCodesSNOMEDCThttp://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ActivityDefinition.intent | required | http://hl7.org/fhir/ValueSet/request-intent|4.0.1http://hl7.org/fhir/ValueSet/request-intent|4.0.1 | ||||
ActivityDefinition.priority | required | http://hl7.org/fhir/ValueSet/request-priority|4.0.1http://hl7.org/fhir/ValueSet/request-priority|4.0.1 | ||||
ActivityDefinition.timing[x].repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.timing[x].repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.timing[x].repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.timing[x].repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.timing[x].code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard | ||||
ActivityDefinition.participant.type | required | http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1 | ||||
ActivityDefinition.participant.role | example | http://hl7.org/fhir/ValueSet/action-participant-rolehttp://hl7.org/fhir/ValueSet/action-participant-role | ||||
ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
ActivityDefinition.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
ActivityDefinition.dosage.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.dosage.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.dosage.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.dosage.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|5.0.0 from the FHIR Standard | ||||
ActivityDefinition.dosage.timing.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation from the FHIR Standard | ||||
ActivityDefinition.dosage.asNeededFor | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ActivityDefinition.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
ActivityDefinition.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
ActivityDefinition.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
ActivityDefinition.dosage.doseAndRate.type | example | DoseAndRateTypehttp://terminology.hl7.org/ValueSet/dose-rate-type | ||||
ActivityDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
code-xor-repeat | error | ActivityDefinition.timing[x], ActivityDefinition.dosage.timing | Either a code or a repeat structure should be defined, but not both : code.empty() or repeat.empty() | |
no-timing-if-dosage-specified | error | ActivityDefinition | If a dosage is specified, there SHALL be no timing element at the same level (instead the timing element of dosage should be used) : dosage.exists() implies timing.exists().not() |