Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DrugKnowledge | Version: current | |||
Draft as of 2022-03-04 | Computable Name: DrugKnowledge |
This profile constrains the base resource MedicationKnowledge to represent an item in a catalog of medications.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationKnowledge
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
code | 1..1 | CodeableConcept | Code that identifies this medication | |
intendedJurisdiction | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
indicationGuideline | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
indication | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
clinicalUseIssue | S | 0..* | Reference(ClinicalUseDefinition) | Potential clinical issue with or between medication(s) |
definitional | S | 0..1 | BackboneElement | Minimal definition information about the medication |
doseForm | S | 0..1 | CodeableConcept | powder | tablets | capsule + |
drugCharacteristic | ||||
value[x] | 1..1 | CodeableConcept, string, SimpleQuantity, base64Binary, Attachment | Description of the characteristic | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | CodeableConcept | Code that identifies this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | entered-in-error | inactive Binding: MedicationKnowledgeStatusCodes (required): A coded concept defining if the medication is in active use. |
intendedJurisdiction | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
indicationGuideline | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
indication | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
clinicalUseIssue | S | 0..* | Reference(ClinicalUseDefinition) | Potential clinical issue with or between medication(s) |
definitional | S | 0..1 | BackboneElement | Minimal definition information about the medication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
doseForm | S | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationKnowledge.code | example | SNOMEDCTMedicationCodes |
MedicationKnowledge.status | required | MedicationKnowledgeStatusCodes |
MedicationKnowledge.definitional.doseForm | example | SNOMEDCTFormCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
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 | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier for this medication |
code | Σ | 1..1 | CodeableConcept | Code that identifies this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | entered-in-error | inactive 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 | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
name | Σ | 0..* | string | A name associated with the medication being described |
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 | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
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 | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
dosingGuideline | 0..* | 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 | |
dosage | 0..* | BackboneElement | Dosage for the medication for the specific guidelines | |
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 for a medication | |
dosage | 1..* | Dosage | Dosage for the medication for the specific guidelines | |
administrationTreatment | 0..1 | CodeableConcept | Type of treatment the guideline applies to | |
patientCharacteristic | 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines | |
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 specific characteristic that is relevant to the administration guideline | |
value[x] | 0..1 | The specific characteristic | ||
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 | S | 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 | 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 | S | 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 | S | 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] | 1..1 | Description of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | Quantity(SimpleQuantity) | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
Documentation for this format |
Path | Conformance | ValueSet |
MedicationKnowledge.language | required | AllLanguages |
MedicationKnowledge.code | example | SNOMEDCTMedicationCodes |
MedicationKnowledge.status | required | MedicationKnowledgeStatusCodes |
MedicationKnowledge.cost.cost[x] | example | MedicationCostCategoryCodes |
MedicationKnowledge.definitional.doseForm | example | SNOMEDCTFormCodes |
MedicationKnowledge.definitional.intendedRoute | example | SNOMEDCTRouteCodes |
MedicationKnowledge.definitional.ingredient.type | example | RoleClassIngredientEntity |
MedicationKnowledge.definitional.ingredient.strength[x] | example | MedicationIngredientStrengthCodes |
MedicationKnowledge.definitional.drugCharacteristic.type | example | MedicationKnowledgeCharacteristicCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from MedicationKnowledge
Differential View
This structure is derived from MedicationKnowledge
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
code | 1..1 | CodeableConcept | Code that identifies this medication | |
intendedJurisdiction | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
indicationGuideline | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
indication | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
clinicalUseIssue | S | 0..* | Reference(ClinicalUseDefinition) | Potential clinical issue with or between medication(s) |
definitional | S | 0..1 | BackboneElement | Minimal definition information about the medication |
doseForm | S | 0..1 | CodeableConcept | powder | tablets | capsule + |
drugCharacteristic | ||||
value[x] | 1..1 | CodeableConcept, string, SimpleQuantity, base64Binary, Attachment | Description of the characteristic | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
code | Σ | 1..1 | CodeableConcept | Code that identifies this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | entered-in-error | inactive Binding: MedicationKnowledgeStatusCodes (required): A coded concept defining if the medication is in active use. |
intendedJurisdiction | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
indicationGuideline | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
indication | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
clinicalUseIssue | S | 0..* | Reference(ClinicalUseDefinition) | Potential clinical issue with or between medication(s) |
definitional | S | 0..1 | BackboneElement | Minimal definition information about the medication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
doseForm | S | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationKnowledge.code | example | SNOMEDCTMedicationCodes |
MedicationKnowledge.status | required | MedicationKnowledgeStatusCodes |
MedicationKnowledge.definitional.doseForm | example | SNOMEDCTFormCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | 0..* | MedicationKnowledge | Definition of Medication Knowledge | |
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 | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
CatalogReference | 0..* | Reference(Catalog Header) | Reference to a catalog URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/CatalogReference | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier for this medication |
code | Σ | 1..1 | CodeableConcept | Code that identifies this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication. |
status | ?!Σ | 0..1 | code | active | entered-in-error | inactive 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 | S | 0..* | CodeableConcept | Codes that identify the different jurisdictions for which the information of this resource was created |
name | Σ | 0..* | string | A name associated with the medication being described |
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 | S | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication |
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 | S | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline |
dosingGuideline | 0..* | 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 | |
dosage | 0..* | BackboneElement | Dosage for the medication for the specific guidelines | |
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 for a medication | |
dosage | 1..* | Dosage | Dosage for the medication for the specific guidelines | |
administrationTreatment | 0..1 | CodeableConcept | Type of treatment the guideline applies to | |
patientCharacteristic | 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines | |
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 specific characteristic that is relevant to the administration guideline | |
value[x] | 0..1 | The specific characteristic | ||
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 | S | 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 | 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 | S | 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 | S | 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] | 1..1 | Description of the characteristic | ||
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | Quantity(SimpleQuantity) | |||
valueBase64Binary | base64Binary | |||
valueAttachment | Attachment | |||
Documentation for this format |
Path | Conformance | ValueSet |
MedicationKnowledge.language | required | AllLanguages |
MedicationKnowledge.code | example | SNOMEDCTMedicationCodes |
MedicationKnowledge.status | required | MedicationKnowledgeStatusCodes |
MedicationKnowledge.cost.cost[x] | example | MedicationCostCategoryCodes |
MedicationKnowledge.definitional.doseForm | example | SNOMEDCTFormCodes |
MedicationKnowledge.definitional.intendedRoute | example | SNOMEDCTRouteCodes |
MedicationKnowledge.definitional.ingredient.type | example | RoleClassIngredientEntity |
MedicationKnowledge.definitional.ingredient.strength[x] | example | MedicationIngredientStrengthCodes |
MedicationKnowledge.definitional.drugCharacteristic.type | example | MedicationKnowledgeCharacteristicCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from MedicationKnowledge
Other representations of profile: CSV, Excel, Schematron