Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicationKnowledge

class HS.FHIR.DTL.vR4.Model.Resource.MedicationKnowledge extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Definition of Medication Knowledge.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = MedicationKnowledge;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 administrationGuidelines as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.administrationGuidelines (XMLNAME = "administrationGuidelines", XMLPROJECTION = "ELEMENT");
BackboneElement

Guidelines for administration of the medication.

Property methods: administrationGuidelinesBuildValueArray(), administrationGuidelinesCollectionToDisplay(), administrationGuidelinesCollectionToOdbc(), administrationGuidelinesDisplayToCollection(), administrationGuidelinesGet(), administrationGuidelinesGetObject(), administrationGuidelinesGetObjectId(), administrationGuidelinesGetSwizzled(), administrationGuidelinesIsValid(), administrationGuidelinesOdbcToCollection(), administrationGuidelinesSet(), administrationGuidelinesSetObject(), administrationGuidelinesSetObjectId()
property amount as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "amount", XMLPROJECTION = "ELEMENT");
Quantity

Amount of drug in package.

Property methods: amountGet(), amountGetSwizzled(), amountIsValid(), amountNewObject(), amountSet()
property associatedMedication as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "associatedMedication", XMLPROJECTION = "ELEMENT");
Reference

A medication resource that is associated with this medication.

Medication

Property methods: associatedMedicationBuildValueArray(), associatedMedicationCollectionToDisplay(), associatedMedicationCollectionToOdbc(), associatedMedicationDisplayToCollection(), associatedMedicationGet(), associatedMedicationGetObject(), associatedMedicationGetObjectId(), associatedMedicationGetSwizzled(), associatedMedicationIsValid(), associatedMedicationOdbcToCollection(), associatedMedicationSet(), associatedMedicationSetObject(), associatedMedicationSetObjectId()
property code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Code that identifies this medication.

any FHIR4 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contraindication as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "contraindication", XMLPROJECTION = "ELEMENT");
Reference

Potential clinical issue with or between medication(s)

DetectedIssue

Property methods: contraindicationBuildValueArray(), contraindicationCollectionToDisplay(), contraindicationCollectionToOdbc(), contraindicationDisplayToCollection(), contraindicationGet(), contraindicationGetObject(), contraindicationGetObjectId(), contraindicationGetSwizzled(), contraindicationIsValid(), contraindicationOdbcToCollection(), contraindicationSet(), contraindicationSetObject(), contraindicationSetObjectId()
property cost as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.cost (XMLNAME = "cost", XMLPROJECTION = "ELEMENT");
BackboneElement

The pricing of the medication.

Property methods: costBuildValueArray(), costCollectionToDisplay(), costCollectionToOdbc(), costDisplayToCollection(), costGet(), costGetObject(), costGetObjectId(), costGetSwizzled(), costIsValid(), costOdbcToCollection(), costSet(), costSetObject(), costSetObjectId()
property doseForm as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "doseForm", XMLPROJECTION = "ELEMENT");
CodeableConcept

powder | tablets | capsule +

any FHIR4 code may be used; medication-form-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: doseFormGet(), doseFormGetSwizzled(), doseFormIsValid(), doseFormNewObject(), doseFormSet()
property drugCharacteristic as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.drugCharacteristic (XMLNAME = "drugCharacteristic", XMLPROJECTION = "ELEMENT");
BackboneElement

Specifies descriptive properties of the medicine.

Property methods: drugCharacteristicBuildValueArray(), drugCharacteristicCollectionToDisplay(), drugCharacteristicCollectionToOdbc(), drugCharacteristicDisplayToCollection(), drugCharacteristicGet(), drugCharacteristicGetObject(), drugCharacteristicGetObjectId(), drugCharacteristicGetSwizzled(), drugCharacteristicIsValid(), drugCharacteristicOdbcToCollection(), drugCharacteristicSet(), drugCharacteristicSetObject(), drugCharacteristicSetObjectId()
property ingredient as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.ingredient (XMLNAME = "ingredient", XMLPROJECTION = "ELEMENT");
BackboneElement

Active or inactive ingredient.

Property methods: ingredientBuildValueArray(), ingredientCollectionToDisplay(), ingredientCollectionToOdbc(), ingredientDisplayToCollection(), ingredientGet(), ingredientGetObject(), ingredientGetObjectId(), ingredientGetSwizzled(), ingredientIsValid(), ingredientOdbcToCollection(), ingredientSet(), ingredientSetObject(), ingredientSetObjectId()
property intendedRoute as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "intendedRoute", XMLPROJECTION = "ELEMENT");
CodeableConcept

The intended or approved route of administration.

any FHIR4 code may be used; route-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: intendedRouteBuildValueArray(), intendedRouteCollectionToDisplay(), intendedRouteCollectionToOdbc(), intendedRouteDisplayToCollection(), intendedRouteGet(), intendedRouteGetObject(), intendedRouteGetObjectId(), intendedRouteGetSwizzled(), intendedRouteIsValid(), intendedRouteOdbcToCollection(), intendedRouteSet(), intendedRouteSetObject(), intendedRouteSetObjectId()
property kinetics as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.kinetics (XMLNAME = "kinetics", XMLPROJECTION = "ELEMENT");
BackboneElement

The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Property methods: kineticsBuildValueArray(), kineticsCollectionToDisplay(), kineticsCollectionToOdbc(), kineticsDisplayToCollection(), kineticsGet(), kineticsGetObject(), kineticsGetObjectId(), kineticsGetSwizzled(), kineticsIsValid(), kineticsOdbcToCollection(), kineticsSet(), kineticsSetObject(), kineticsSetObjectId()
property manufacturer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "manufacturer", XMLPROJECTION = "ELEMENT");
Reference

Manufacturer of the item.

Organization

Property methods: manufacturerGet(), manufacturerGetSwizzled(), manufacturerIsValid(), manufacturerNewObject(), manufacturerSet()
property medicineClassification as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.medicineClassification (XMLNAME = "medicineClassification", XMLPROJECTION = "ELEMENT");
BackboneElement

Categorization of the medication within a formulary or classification system.

Property methods: medicineClassificationBuildValueArray(), medicineClassificationCollectionToDisplay(), medicineClassificationCollectionToOdbc(), medicineClassificationDisplayToCollection(), medicineClassificationGet(), medicineClassificationGetObject(), medicineClassificationGetObjectId(), medicineClassificationGetSwizzled(), medicineClassificationIsValid(), medicineClassificationOdbcToCollection(), medicineClassificationSet(), medicineClassificationSetObject(), medicineClassificationSetObjectId()
property monitoringProgram as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.monitoringProgram (XMLNAME = "monitoringProgram", XMLPROJECTION = "ELEMENT");
BackboneElement

Program under which a medication is reviewed.

Property methods: monitoringProgramBuildValueArray(), monitoringProgramCollectionToDisplay(), monitoringProgramCollectionToOdbc(), monitoringProgramDisplayToCollection(), monitoringProgramGet(), monitoringProgramGetObject(), monitoringProgramGetObjectId(), monitoringProgramGetSwizzled(), monitoringProgramIsValid(), monitoringProgramOdbcToCollection(), monitoringProgramSet(), monitoringProgramSetObject(), monitoringProgramSetObjectId()
property monograph as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.monograph (XMLNAME = "monograph", XMLPROJECTION = "ELEMENT");
BackboneElement

Associated documentation about the medication.

Property methods: monographBuildValueArray(), monographCollectionToDisplay(), monographCollectionToOdbc(), monographDisplayToCollection(), monographGet(), monographGetObject(), monographGetObjectId(), monographGetSwizzled(), monographIsValid(), monographOdbcToCollection(), monographSet(), monographSetObject(), monographSetObjectId()
property packaging as HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.packaging (XMLNAME = "packaging", XMLPROJECTION = "ELEMENT");
BackboneElement

Details about packaged medications.

Property methods: packagingGet(), packagingGetSwizzled(), packagingIsValid(), packagingNewObject(), packagingSet()
property preparationInstruction as %String (MAXLEN = 1000000, XMLNAME = "preparationInstruction", XMLPROJECTION = "ATTRIBUTE");
markdown

The instructions for preparing the medication.

Property methods: preparationInstructionDisplayToLogical(), preparationInstructionGet(), preparationInstructionIsValid(), preparationInstructionLogicalToDisplay(), preparationInstructionLogicalToOdbc(), preparationInstructionNormalize(), preparationInstructionSet()
property productType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "productType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Category of the medication or product.

any FHIR4 code from any ValueSet may be used.

Property methods: productTypeBuildValueArray(), productTypeCollectionToDisplay(), productTypeCollectionToOdbc(), productTypeDisplayToCollection(), productTypeGet(), productTypeGetObject(), productTypeGetObjectId(), productTypeGetSwizzled(), productTypeIsValid(), productTypeOdbcToCollection(), productTypeSet(), productTypeSetObject(), productTypeSetObjectId()
property regulatory as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.regulatory (XMLNAME = "regulatory", XMLPROJECTION = "ELEMENT");
BackboneElement

Regulatory information about a medication.

Property methods: regulatoryBuildValueArray(), regulatoryCollectionToDisplay(), regulatoryCollectionToOdbc(), regulatoryDisplayToCollection(), regulatoryGet(), regulatoryGetObject(), regulatoryGetObjectId(), regulatoryGetSwizzled(), regulatoryIsValid(), regulatoryOdbcToCollection(), regulatorySet(), regulatorySetObject(), regulatorySetObjectId()
property relatedMedicationKnowledge as list of HS.FHIR.DTL.vR4.Model.Element.MedicationKnowledge.relatedMedicationKnowledge (XMLNAME = "relatedMedicationKnowledge", XMLPROJECTION = "ELEMENT");
BackboneElement

Associated or related medication information.

Property methods: relatedMedicationKnowledgeBuildValueArray(), relatedMedicationKnowledgeCollectionToDisplay(), relatedMedicationKnowledgeCollectionToOdbc(), relatedMedicationKnowledgeDisplayToCollection(), relatedMedicationKnowledgeGet(), relatedMedicationKnowledgeGetObject(), relatedMedicationKnowledgeGetObjectId(), relatedMedicationKnowledgeGetSwizzled(), relatedMedicationKnowledgeIsValid(), relatedMedicationKnowledgeOdbcToCollection(), relatedMedicationKnowledgeSet(), relatedMedicationKnowledgeSetObject(), relatedMedicationKnowledgeSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

active | inactive | entered-in-error

medicationknowledge-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medicationknowledge-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property synonym as list of %String (MAXLEN = 1000000, XMLNAME = "synonym", XMLPROJECTION = "ELEMENT");
string

Additional names for a medication.

Property methods: synonymBuildValueArray(), synonymCollectionToDisplay(), synonymCollectionToOdbc(), synonymDisplayToCollection(), synonymDisplayToLogical(), synonymGet(), synonymGetObject(), synonymGetObjectId(), synonymGetSwizzled(), synonymIsValid(), synonymLogicalToDisplay(), synonymLogicalToOdbc(), synonymNormalize(), synonymOdbcToCollection(), synonymSet(), synonymSetObject(), synonymSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab