Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.vSTU3.Model.Resource.Medication

deprecated class HS.FHIR.vSTU3.Model.Resource.Medication extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method 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 = Medication;
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 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.

Properties

property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A code (or set of codes) that specify 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 form as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "form", XMLPROJECTION = "ELEMENT");
Describes the form of the item. Powder; tablets; capsule.
Property methods: formGet(), formGetSwizzled(), formIsValid(), formNewObject(), formSet()
property image as list of HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "image", XMLPROJECTION = "ELEMENT");
Photo(s) or graphic representation(s) of the medication.
Property methods: imageBuildValueArray(), imageCollectionToDisplay(), imageCollectionToOdbc(), imageDisplayToCollection(), imageGet(), imageGetObject(), imageGetObjectId(), imageGetSwizzled(), imageIsValid(), imageOdbcToCollection(), imageSet(), imageSetObject(), imageSetObjectId()
property ingredient as list of HS.FHIR.vSTU3.Model.Resource.Medication.Ingredient (XMLNAME = "ingredient", XMLPROJECTION = "ELEMENT");
Identifies a particular constituent of interest in the product.
Property methods: ingredientBuildValueArray(), ingredientCollectionToDisplay(), ingredientCollectionToOdbc(), ingredientDisplayToCollection(), ingredientGet(), ingredientGetObject(), ingredientGetObjectId(), ingredientGetSwizzled(), ingredientIsValid(), ingredientOdbcToCollection(), ingredientSet(), ingredientSetObject(), ingredientSetObjectId()
property isBrand as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "isBrand", XMLPROJECTION = "ELEMENT");
Set to true if the item is attributable to a specific manufacturer.
Property methods: isBrandGet(), isBrandGetSwizzled(), isBrandIsValid(), isBrandNewObject(), isBrandSet()
property isOverTheCounter as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "isOverTheCounter", XMLPROJECTION = "ELEMENT");
Set to true if the medication can be obtained without an order from a prescriber.
Property methods: isOverTheCounterGet(), isOverTheCounterGetSwizzled(), isOverTheCounterIsValid(), isOverTheCounterNewObject(), isOverTheCounterSet()
property manufacturer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "manufacturer", XMLPROJECTION = "ELEMENT");
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()
property package as HS.FHIR.vSTU3.Model.Resource.Medication.Package (XMLNAME = "package", XMLPROJECTION = "ELEMENT");
Information that only applies to packages (not products).
Property methods: packageGet(), packageGetSwizzled(), packageIsValid(), packageNewObject(), packageSet()
property status as HS.FHIR.vSTU3.Model.Base.MedicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
A code to indicate if the medication is in active use.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetForm(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "form" property.
deprecated method SetImage(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "image" property.
deprecated method SetIsBrand(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "isBrand" property.
deprecated method SetIsOverTheCounter(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "isOverTheCounter" property.
deprecated method SetManufacturer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "manufacturer" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab