MedicationKnowledge

@POJOBoilerplate
class MedicationKnowledge(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val status: Option[MEDICATIONKNOWLEDGE_STATUS], val amount: Option[Quantity], val synonym: LitSeq[String], val language: Option[LANGUAGES], val doseForm: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val productType: LitSeq[CodeableConcept], val manufacturer: Option[Reference], val implicitRules: Option[UriStr], val intendedRoute: LitSeq[CodeableConcept], val contraindication: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val associatedMedication: LitSeq[Reference], val preparationInstruction: Option[Markdown], val cost: LitSeq[Cost], val kinetics: LitSeq[Kinetics], val monograph: LitSeq[Monograph], val packaging: Option[Packaging], val ingredient: LitSeq[Ingredient], val monitoringProgram: LitSeq[MonitoringProgram], val drugCharacteristic: LitSeq[DrugCharacteristic], val medicineClassification: LitSeq[MedicineClassification], val regulatory: LitSeq[Regulatory], val relatedMedicationKnowledge: LitSeq[RelatedMedicationKnowledge], val administrationGuidelines: LitSeq[AdministrationGuidelines], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Information about a medication that is used to support knowledge.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
administrationGuidelines
  • Guidelines for the administration of the medication.
amount
  • 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.).
associatedMedication
  • 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).
code
  • 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.
contained
  • 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.
contraindication
  • Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
cost
  • The price of the medication.
doseForm
  • Describes the form of the item. Powder; tablets; capsule.
drugCharacteristic
  • Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
extension
  • 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.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • 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.
ingredient
  • Identifies a particular constituent of interest in the product.
intendedRoute
  • The intended or approved route of administration.
kinetics
  • The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
language
  • The base language in which the resource is written.
manufacturer
  • Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
medicineClassification
  • Categorization of the medication within a formulary or classification system.
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.
modifierExtension
  • 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).
monitoringProgram
  • The program under which the medication is reviewed.
monograph
  • Associated documentation about the medication.
packaging
  • Information that only applies to packages (not products).
preparationInstruction
  • The instructions for preparing the medication.
productType
  • Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
regulatory
  • Regulatory information about a medication.
relatedMedicationKnowledge
  • Associated or related knowledge about a medication.
status
  • 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.
synonym
  • 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.
text
  • 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.
Constructor:

Introduces the fields code, status, amount, synonym, doseForm, productType, manufacturer, intendedRoute, contraindication, associatedMedication, preparationInstruction, cost, kinetics, monograph, packaging, ingredient, monitoringProgram, drugCharacteristic, medicineClassification, regulatory, relatedMedicationKnowledge, administrationGuidelines.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): MedicationKnowledge

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[MedicationKnowledge]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: MedicationKnowledge <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: MedicationKnowledge <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): MedicationKnowledge

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: MedicationKnowledge <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: MedicationKnowledge <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): MedicationKnowledge
Inherited from:
FHIRObject
def withField[T : LTag, Up >: MedicationKnowledge <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: MedicationKnowledge <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: MedicationKnowledge <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): MedicationKnowledge
Inherited from:
FHIRObject

Concrete fields

val amount: Option[Quantity]
val associatedMedication: LitSeq[Reference]
val code: Option[CodeableConcept]
override val contained: LitSeq[Resource]
val contraindication: LitSeq[Reference]
val cost: LitSeq[Cost]
val doseForm: Option[CodeableConcept]
override val extension: LitSeq[Extension]
override val id: Option[String]
override val implicitRules: Option[UriStr]
val ingredient: LitSeq[Ingredient]
val intendedRoute: LitSeq[CodeableConcept]
val kinetics: LitSeq[Kinetics]
override val language: Option[LANGUAGES]
val manufacturer: Option[Reference]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val monograph: LitSeq[Monograph]
val packaging: Option[Packaging]
val preparationInstruction: Option[Markdown]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val productType: LitSeq[CodeableConcept]
val regulatory: LitSeq[Regulatory]
val synonym: LitSeq[String]
override val text: Option[Narrative]
override val thisTypeName: String

Inherited fields

val companion: CompanionFor[MedicationKnowledge]
Inherited from:
FHIRObject