Global Core Electronic Medicinal Product Information (ePI)
1.1.0 - trial-use World

Global Core Electronic Medicinal Product Information (ePI), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationKnowledge (ePI) ( Experimental )

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/MedicationKnowledge-uv-epi Version: 1.1.0
Standards status: Informative Computable Name: MedicationKnowledgeUvEpi

MedicationKnowledge (ePI) - ported from Business Friendly ePI Outline

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... name Σ 0..* string Common name for the medication
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dosage 1..* BackboneElement Dosage for the medication
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... coding Σ 0..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..1 string Representation defined by the system
...... dosage 1..* Dosage Dosage for the medication
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... coding Σ 1..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..1 string Representation defined by the system
...... value[x] 0..1 The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationKnowledge.​status Base required MedicationKnowledge Status Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... code 0..0 Code that identifies this medication
... status 0..1 code active | inactive | entered-in-error
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... treatmentIntent
...... coding 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
....... display 1..1 string Representation defined by the system
..... dosage 1..* BackboneElement Dosage for the medication
...... type 1..1 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... coding 0..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system
........ display 1..1 string Representation defined by the system
...... dosage 1..* Dosage Dosage for the medication
..... administrationTreatment 0..0 Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... type 1..1 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... coding 1..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system
........ display 1..1 string Representation defined by the system
...... value[x] 0..1 CodeableConcept, Quantity, Range The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this 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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationKnowledgeStatusCodes (required): A coded concept defining if the medication is in active use.
... author 0..1 Reference(Organization) Creator or owner of the knowledge or information about the medication
... intendedJurisdiction 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created
... name Σ 0..* string Common name for the medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... 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 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
... associatedMedication 0..* Reference(Medication) The set of medication resources that are associated with this medication
... productType 0..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference) Associated documentation about the medication
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... cost 0..* BackboneElement The pricing of the medication
.... 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
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... monitoringProgram Σ 0..* BackboneElement Program under which a medication is reviewed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... 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
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... 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
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
....... 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 1..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 1..* BackboneElement Dosage for the medication
...... 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 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 0..1 Coding Code defined by a terminology system
........ 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 Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..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 1..* Dosage Dosage for the medication
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... 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 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ 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 Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..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
...... value[x] 0..1 The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... 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 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... source[x] 0..1 The source of the classification
..... sourceString string
..... sourceUri uri
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..* BackboneElement Details about packaged medications
.... 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
.... cost 0..* See cost (MedicationKnowledge) Cost of the packaged medication
.... packagedProduct 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced
... clinicalUseIssue 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s)
... storageGuideline 0..* BackboneElement How the medication should be stored
.... 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
.... reference 0..1 uri Reference to additional information
.... note 0..* Annotation Additional storage notes
.... stabilityDuration 0..1 Duration Duration remains stable
.... environmentalSetting 0..* BackboneElement Setting or value of environment for adequate storage
..... 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 CodeableConcept Categorization of the setting
..... value[x] 1..1 Value of the setting
...... valueQuantity Quantity
...... valueRange Range
...... valueCodeableConcept CodeableConcept
... regulatory 0..* BackboneElement Regulatory information about a medication
.... 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
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1 SimpleQuantity(5.0.0) The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... definitional 0..1 BackboneElement Minimal definition information about the medication
.... 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
.... definition 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication
.... doseForm 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
.... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example)
.... ingredient Σ 0..* BackboneElement Active or inactive ingredient
..... 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
..... item Σ 1..1 CodeableReference(Substance) Substances contained in the medication
..... type 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc
Binding: RoleClassIngredientEntity (example)
..... strength[x] 0..1 Quantity of ingredient present
Binding: MedicationIngredientStrengthCodes (example)
...... strengthRatio Ratio
...... strengthCodeableConcept CodeableConcept
...... strengthQuantity Quantity
.... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: MedicationKnowledgeCharacteristicCodes (example)
..... value[x] 0..1 Description of the characteristic
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueQuantity Quantity(SimpleQuantity)
...... valueBase64Binary base64Binary
...... valueAttachment Attachment

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationKnowledge.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicationKnowledge.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
MedicationKnowledge.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​status Base required MedicationKnowledge Status Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​cost.cost[x] Base example Medication Cost Category Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG
MedicationKnowledge.​definitional.doseForm Base example SNOMED CT Form Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.intendedRoute Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.ingredient.​type Base example RoleClassIngredientEntity 📦3.0.0 THO v7.2
MedicationKnowledge.​definitional.ingredient.​strength[x] Base example Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.drugCharacteristic.​type Base example medicationKnowledge Characteristic Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... name Σ 0..* string Common name for the medication
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dosage 1..* BackboneElement Dosage for the medication
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... coding Σ 0..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..1 string Representation defined by the system
...... dosage 1..* Dosage Dosage for the medication
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... coding Σ 1..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..1 string Representation defined by the system
...... value[x] 0..1 The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationKnowledge.​status Base required MedicationKnowledge Status Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... code 0..0 Code that identifies this medication
... status 0..1 code active | inactive | entered-in-error
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... treatmentIntent
...... coding 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
....... display 1..1 string Representation defined by the system
..... dosage 1..* BackboneElement Dosage for the medication
...... type 1..1 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... coding 0..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system
........ display 1..1 string Representation defined by the system
...... dosage 1..* Dosage Dosage for the medication
..... administrationTreatment 0..0 Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... type 1..1 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... coding 1..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system
........ display 1..1 string Representation defined by the system
...... value[x] 0..1 CodeableConcept, Quantity, Range The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationKnowledge 0..* MedicationKnowledge Definition of Medication Knowledge
Interfaces Implemented: MetadataResource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this 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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationKnowledgeStatusCodes (required): A coded concept defining if the medication is in active use.
... author 0..1 Reference(Organization) Creator or owner of the knowledge or information about the medication
... intendedJurisdiction 0..* CodeableConcept Codes that identify the different jurisdictions for which the information of this resource was created
... name Σ 0..* string Common name for the medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... 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 CodeableConcept Category of medicationKnowledge
.... reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
... associatedMedication 0..* Reference(Medication) The set of medication resources that are associated with this medication
... productType 0..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference) Associated documentation about the medication
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... cost 0..* BackboneElement The pricing of the medication
.... 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
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... monitoringProgram Σ 0..* BackboneElement Program under which a medication is reviewed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 1..* BackboneElement Guidelines for administration of the medication
.... 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
.... indication 1..* CodeableReference(ClinicalUseDefinition Indication (ePI)) Indication for use that applies to the specific administration guideline
.... dosingGuideline 1..* BackboneElement Guidelines for dosage of the medication
..... 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
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..1 Coding Code defined by a terminology system
....... 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 Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 1..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 1..* BackboneElement Dosage for the medication
...... 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 CodeableConcept Category of dosage (e.g., Initial/Loading, Maintenance, Target, Maximum, Minimum). Code where a suitable system exists; otherwise use text.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 0..1 Coding Code defined by a terminology system
........ 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 Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..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 1..* Dosage Dosage for the medication
..... patientCharacteristic 0..* BackboneElement Population this dose row is for. Use ONLY to stratify dose WITHIN one indication (e.g., adult vs child vs neonate for the same condition). When the dose population equals the indication's population, leave this empty and rely on the indication's ClinicalUseDefinition.population (a Group). Do not double-encode the same population here and on the Group.
...... 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 CodeableConcept The population axis (sex, age, weight, ...). Same vocabulary as Group.characteristic.code.
Binding: Group Characteristic Type (ePI) (extensible)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ 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 Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code ΣC 1..1 code Symbol in syntax defined by the system
........ display ΣC 1..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
...... value[x] 0..1 The value on that axis - mirrors Group.characteristic.value[x] (CodeableConcept, Quantity or Range).
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... 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 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... source[x] 0..1 The source of the classification
..... sourceString string
..... sourceUri uri
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..* BackboneElement Details about packaged medications
.... 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
.... cost 0..* See cost (MedicationKnowledge) Cost of the packaged medication
.... packagedProduct 0..1 Reference(PackagedProductDefinition) The packaged medication that is being priced
... clinicalUseIssue 0..* Reference(ClinicalUseDefinition) Potential clinical issue with or between medication(s)
... storageGuideline 0..* BackboneElement How the medication should be stored
.... 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
.... reference 0..1 uri Reference to additional information
.... note 0..* Annotation Additional storage notes
.... stabilityDuration 0..1 Duration Duration remains stable
.... environmentalSetting 0..* BackboneElement Setting or value of environment for adequate storage
..... 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 CodeableConcept Categorization of the setting
..... value[x] 1..1 Value of the setting
...... valueQuantity Quantity
...... valueRange Range
...... valueCodeableConcept CodeableConcept
... regulatory 0..* BackboneElement Regulatory information about a medication
.... 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
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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 CodeableConcept Specifies the type of substitution allowed
..... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
.... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1 SimpleQuantity(5.0.0) The maximum number of units of the medication that can be dispensed
..... period 0..1 Duration The period that applies to the maximum number of units
... definitional 0..1 BackboneElement Minimal definition information about the medication
.... 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
.... definition 0..* Reference(MedicinalProductDefinition) Definitional resources that provide more information about this medication
.... doseForm 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example)
.... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example)
.... ingredient Σ 0..* BackboneElement Active or inactive ingredient
..... 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
..... item Σ 1..1 CodeableReference(Substance) Substances contained in the medication
..... type 0..1 CodeableConcept A code that defines the type of ingredient, active, base, etc
Binding: RoleClassIngredientEntity (example)
..... strength[x] 0..1 Quantity of ingredient present
Binding: MedicationIngredientStrengthCodes (example)
...... strengthRatio Ratio
...... strengthCodeableConcept CodeableConcept
...... strengthQuantity Quantity
.... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Binding: MedicationKnowledgeCharacteristicCodes (example)
..... value[x] 0..1 Description of the characteristic
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueQuantity Quantity(SimpleQuantity)
...... valueBase64Binary base64Binary
...... valueAttachment Attachment

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationKnowledge.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicationKnowledge.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
MedicationKnowledge.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​status Base required MedicationKnowledge Status Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​cost.cost[x] Base example Medication Cost Category Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​indicationGuideline.​dosingGuideline.patientCharacteristic.​type Base extensible Group Characteristic Type (ePI) 📦1.1.0 This IG
MedicationKnowledge.​definitional.doseForm Base example SNOMED CT Form Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.intendedRoute Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.ingredient.​type Base example RoleClassIngredientEntity 📦3.0.0 THO v7.2
MedicationKnowledge.​definitional.ingredient.​strength[x] Base example Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.
MedicationKnowledge.​definitional.drugCharacteristic.​type Base example medicationKnowledge Characteristic Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Prohibited: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron