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: Drug Administration Action

Defining URL:https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/drug-administration-action
Version:0.3.1
Name:DrugAdministrationAction
Title:Drug Administration Action
Status:Draft as of 2022-09-06
Definition:

Definition of a drug administration action as part of a recommended intervention.

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/drug-administration-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)
dosage-if-administration-should-be-performed: Dosage should be defined if the drug administration should be performed
... 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: MedicationRequest
... 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.


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://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 432102000
..... display 1..1 string Representation defined by the system
Fixed Value: Administration of substance (procedure)
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... 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
... 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 CodeableConcept What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:sct Σ 0..1 Coding Code defined by a terminology system
Binding: Substances SNOMED CT (required)

Required Pattern: At least the following
...... 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://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:atc Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... 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://www.whocc.no/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rxnorm Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... 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://www.nlm.nih.gov/research/umls/rxnorm
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
...... display ΣC 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:atcde Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... 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://fhir.de/CodeSystem/bfarm/atc
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣC 1..1 code Symbol in syntax defined by the system
...... display ΣC 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
... dosage S 0..* Dosage Detailed dosage instructions
.... 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
..... condition S 0..1 (Complex) condition
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-dosage-condition
.... 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 1..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 SΣ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (required)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 1..* 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

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


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://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 432102000
..... display 1..1 string Representation defined by the system
Fixed Value: Administration of substance (procedure)
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... location 0..1 Reference(Location) Where it should happen
... participant 0..* BackboneElement Who should participate in the action
... product[x] 0..1 CodeableConcept What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.

.... Slices for coding Content/Rules for all slices
..... coding:sct Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... system Σ 1..1 uri Identity of the terminology system
...... code ΣC 1..1 code Symbol in syntax defined by the system
..... coding:atc Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... system Σ 1..1 uri Identity of the terminology system
...... code ΣC 1..1 code Symbol in syntax defined by the system
..... coding:rxnorm Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls/rxnorm
...... system Σ 1..1 uri Identity of the terminology system
...... code ΣC 1..1 code Symbol in syntax defined by the system
..... coding:atcde Σ 0..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... system Σ 1..1 uri Identity of the terminology system
...... code ΣC 1..1 code Symbol in syntax defined by the system
... dosage 0..* Dosage Detailed dosage instructions
.... Slices for extension Content/Rules for all slices
..... condition 0..1 (Complex) condition
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-dosage-condition
.... timing Σ 1..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
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (required)
... 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 C 1..1 RecommendationAction The definition of a specific activity to be taken, independent of any particular patient or context
dosage-if-administration-should-be-performed: Dosage should be defined if the drug administration should be performed
... kind 1..1 code Kind of resource
Required Pattern: MedicationRequest
... code 1..1 CodeableConcept Detail type of activity
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://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 432102000
..... display 1..1 string Representation defined by the system
Fixed Value: Administration of substance (procedure)
... timing[x] 0..0
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:sct 0..1 Coding Code defined by a terminology system
Binding: Substances SNOMED CT (required)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... coding:atc 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... coding:rxnorm 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls/rxnorm
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... coding:atcde 0..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/bfarm/atc
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
... quantity 0..0
... dosage
.... Slices for extension Content/Rules for all slices
..... condition S 0..1 (Complex) condition
URL: https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/ext-dosage-condition
.... timing 1..1 Timing When medication should be administered
.... route S 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (required)
.... doseAndRate 1..* Element Amount of medication administered, to be administered or typical amount to be administered

doco Documentation for this format

This structure is derived from RecommendationAction

Summary

Mandatory: 0 element(11 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ActivityDefinition.product[x].coding

 

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: MedicationRequest
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
ActivityDefinition.codeexamplePattern: SNOMED-CT Code 432102000("Administration of substance (procedure)")
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.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
ActivityDefinition.product[x].coding:sctrequiredPattern: SNOMED-CT Code null
https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/ValueSet/vs-substances-snomed
from this IG
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.routerequiredSNOMEDCTRouteCodes
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

Constraints

IdGradePath(s)DetailsRequirements
dosage-if-administration-should-be-performedwarningActivityDefinitionDosage should be defined if the drug administration should be performed
: (doNotPerform = false) implies dosage.exists()