Skip to main content

HS.FHIRModel.R4.MedicationKnowledge

class HS.FHIRModel.R4.MedicationKnowledge extends HS.FHIRModel.FHIRClassSuper

*****************************************
** MedicationKnowledge generated class schema
*****************************************
Information about a medication that is used to support knowledge.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_MEDICATIONKNOWLEDGE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _preparationInstruction as HS.FHIRModel.R4.Element;
Extensions for preparationInstruction
Property methods: _preparationInstructionGet(), _preparationInstructionGetSwizzled(), _preparationInstructionIsValid(), _preparationInstructionNewObject(), _preparationInstructionSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _synonym as HS.FHIRModel.R4.SeqOfElement;
Extensions for synonym
Property methods: _synonymGet(), _synonymGetSwizzled(), _synonymIsValid(), _synonymNewObject(), _synonymSet()
Guidelines for the administration of the medication.
Property methods: administrationGuidelinesGet(), administrationGuidelinesGetSwizzled(), administrationGuidelinesIsValid(), administrationGuidelinesNewObject(), administrationGuidelinesSet()
property amount as HS.FHIRModel.R4.Quantity;
Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
Property methods: amountGet(), amountGetSwizzled(), amountIsValid(), amountNewObject(), amountSet()
property associatedMedication as HS.FHIRModel.R4.SeqOfReference;
Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
Property methods: associatedMedicationGet(), associatedMedicationGetSwizzled(), associatedMedicationIsValid(), associatedMedicationNewObject(), associatedMedicationSet()
A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property contraindication as HS.FHIRModel.R4.SeqOfReference;
Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
Property methods: contraindicationGet(), contraindicationGetSwizzled(), contraindicationIsValid(), contraindicationNewObject(), contraindicationSet()
The price of the medication.
Property methods: costGet(), costGetSwizzled(), costIsValid(), costNewObject(), costSet()
property doseForm as HS.FHIRModel.R4.CodeableConcept;
Describes the form of the item. Powder; tablets; capsule.
Property methods: doseFormGet(), doseFormGetSwizzled(), doseFormIsValid(), doseFormNewObject(), doseFormSet()
Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
Property methods: drugCharacteristicGet(), drugCharacteristicGetSwizzled(), drugCharacteristicIsValid(), drugCharacteristicNewObject(), drugCharacteristicSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
Identifies a particular constituent of interest in the product.
Property methods: ingredientGet(), ingredientGetSwizzled(), ingredientIsValid(), ingredientNewObject(), ingredientSet()
property intendedRoute as HS.FHIRModel.R4.SeqOfCodeableConcept;
The intended or approved route of administration.
Property methods: intendedRouteGet(), intendedRouteGetSwizzled(), intendedRouteIsValid(), intendedRouteNewObject(), intendedRouteSet()
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
Property methods: kineticsGet(), kineticsGetSwizzled(), kineticsIsValid(), kineticsNewObject(), kineticsSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property manufacturer as HS.FHIRModel.R4.Reference;
Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
Categorization of the medication within a formulary or classification system.
Property methods: medicineClassificationGet(), medicineClassificationGetSwizzled(), medicineClassificationIsValid(), medicineClassificationNewObject(), medicineClassificationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
The program under which the medication is reviewed.
Property methods: monitoringProgramGet(), monitoringProgramGetSwizzled(), monitoringProgramIsValid(), monitoringProgramNewObject(), monitoringProgramSet()
Associated documentation about the medication.
Property methods: monographGet(), monographGetSwizzled(), monographIsValid(), monographNewObject(), monographSet()
Information that only applies to packages (not products).
Property methods: packagingGet(), packagingGetSwizzled(), packagingIsValid(), packagingNewObject(), packagingSet()
property preparationInstruction as %String;
The instructions for preparing the medication.
Property methods: preparationInstructionDisplayToLogical(), preparationInstructionGet(), preparationInstructionIsValid(), preparationInstructionLogicalToDisplay(), preparationInstructionLogicalToOdbc(), preparationInstructionNormalize(), preparationInstructionSet()
property productType as HS.FHIRModel.R4.SeqOfCodeableConcept;
Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
Property methods: productTypeGet(), productTypeGetSwizzled(), productTypeIsValid(), productTypeNewObject(), productTypeSet()
Regulatory information about a medication.
Property methods: regulatoryGet(), regulatoryGetSwizzled(), regulatoryIsValid(), regulatoryNewObject(), regulatorySet()
Associated or related knowledge about a medication.
Property methods: relatedMedicationKnowledgeGet(), relatedMedicationKnowledgeGetSwizzled(), relatedMedicationKnowledgeIsValid(), relatedMedicationKnowledgeNewObject(), relatedMedicationKnowledgeSet()
property resourceType as %String [ InitialExpression = "MedicationKnowledge" , Required ];
This is a MedicationKnowledge resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property synonym as HS.FHIRModel.R4.SeqOfString;
Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
Property methods: synonymGet(), synonymGetSwizzled(), synonymIsValid(), synonymNewObject(), synonymSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAdministrationGuidelines()
method IncludeAmount()
method IncludeAssociatedMedication()
method IncludeCode()
method IncludeContained()
method IncludeContraindication()
method IncludeCost()
method IncludeDoseForm()
method IncludeDrugCharacteristic()
method IncludeExtension()
method IncludeIngredient()
method IncludeIntendedRoute()
method IncludeKinetics()
method IncludeManufacturer()
method IncludeMedicineClassification()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeMonitoringProgram()
method IncludeMonograph()
method IncludePackaging()
method IncludeProductType()
method IncludeRegulatory()
method IncludeRelatedMedicationKnowledge()
method IncludeSynonym()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab