Clinical Practice Guidelines (CPG) on EBMonFHIR
1.0.2 - ci-build

Clinical Practice Guidelines (CPG) on EBMonFHIR, published by Universitätsmedizin Greifswald. This guide is not an authorized publication; it is the continuous build for version 1.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CEOsys/cpg-on-ebm-on-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: Assessment Action

Defining URL:https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/assessment-action
Version:0.3.1
Name:AssessmentAction
Title:Assessment Action
Status:Draft as of 2023-11-20
Definition:

Definition of an assessment action.

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/assessment-action

Guidance

This profile of a FHIR ActivityDefinition is derived from the recommendation-action FHIR resource.

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C 1..1 RecommendationAction 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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.


Required Pattern: ServiceRequest
... 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 1..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.

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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1 RecommendationAction 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)
... 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.


Required Pattern: ServiceRequest
... 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 1..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
... 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

doco Documentation for this format

This structure is derived from RecommendationAction

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1 RecommendationAction The definition of a specific activity to be taken, independent of any particular patient or context
... kind 1..1 code Kind of resource
Required Pattern: ServiceRequest
... timing[x] 1..1 Timing When activity is to occur
... product[x] 0..0
... dosage 0..0

doco Documentation for this format

This structure is derived from RecommendationAction

Summary

Mandatory: 1 element
Prohibited: 3 elements

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
ActivityDefinition.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
ActivityDefinition.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
ActivityDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ActivityDefinition.extension:knowledgeCapability.value[x]requiredPattern: computable
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-capability
ActivityDefinition.extension:knowledgeRepresentationLevel.value[x]requiredPattern: structured
http://hl7.org/fhir/uv/cpg/ValueSet/cpg-knowledge-representation-level
ActivityDefinition.statusrequiredhttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
ActivityDefinition.subject[x]extensiblePattern: Patient
http://hl7.org/fhir/ValueSet/subject-type
ActivityDefinition.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ActivityDefinition.kindrequiredPattern: ServiceRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
ActivityDefinition.codeexampleProcedureCodesSNOMEDCT
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ActivityDefinition.intentrequiredhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
ActivityDefinition.priorityrequiredhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
ActivityDefinition.timing[x].repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|5.0.0
from the FHIR Standard
ActivityDefinition.timing[x].repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|5.0.0
from the FHIR Standard
ActivityDefinition.timing[x].repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|5.0.0
from the FHIR Standard
ActivityDefinition.timing[x].repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|5.0.0
from the FHIR Standard
ActivityDefinition.timing[x].codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard
ActivityDefinition.participant.typerequiredhttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
ActivityDefinition.participant.roleexamplehttp://hl7.org/fhir/ValueSet/action-participant-role
http://hl7.org/fhir/ValueSet/action-participant-role
ActivityDefinition.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
ActivityDefinition.dosage.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|5.0.0
from the FHIR Standard
ActivityDefinition.dosage.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|5.0.0
from the FHIR Standard
ActivityDefinition.dosage.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|5.0.0
from the FHIR Standard
ActivityDefinition.dosage.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|5.0.0
from the FHIR Standard
ActivityDefinition.dosage.timing.codepreferredTimingAbbreviation
http://hl7.org/fhir/ValueSet/timing-abbreviation
from the FHIR Standard
ActivityDefinition.dosage.asNeededForexampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ActivityDefinition.dosage.siteexampleSNOMEDCTAnatomicalStructureAdministrationSites
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
ActivityDefinition.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
ActivityDefinition.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
ActivityDefinition.dosage.doseAndRate.typeexampleDoseAndRateType
http://terminology.hl7.org/ValueSet/dose-rate-type
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard