Class Medication
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeableConcept
A code (or set of codes) that specify this medication, or a textual description if no code is available.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for containerprotected CodeableConcept
Describes the form of the item.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for formprotected List
<Attachment> Photo(s) or graphic representation(s) of the medication.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Medication.MedicationIngredientComponent> Identifies a particular constituent of interest in the product.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for ingredientstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for ingredient-codeprotected BooleanType
Set to true if the item is attributable to a specific manufacturer.protected BooleanType
Set to true if the medication can be obtained without an order from a prescriber.protected Reference
Describes the details of the manufacturer of the medication product.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for manufacturerprotected Organization
The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for over-the-counterprotected Medication.MedicationPackageComponent
Information that only applies to packages (not products).static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for package-itemstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for package-item-codestatic final String
Search parameter: codestatic final String
Search parameter: containerstatic final String
Search parameter: formstatic final String
Search parameter: ingredientstatic final String
Search parameter: ingredient-codestatic final String
Search parameter: manufacturerstatic final String
Search parameter: over-the-counterstatic final String
Search parameter: package-itemstatic final String
Search parameter: package-item-codestatic final String
Search parameter: statusprotected Enumeration
<Medication.MedicationStatus> A code to indicate if the medication is in active use.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddImage()
copy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getForm()
getImage()
boolean
boolean
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
hasCode()
boolean
hasForm()
boolean
hasImage()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCode
(CodeableConcept value) setForm
(CodeableConcept value) setImage
(List<Attachment> theImage) setIngredient
(List<Medication.MedicationIngredientComponent> theIngredient) setIsBrand
(boolean value) setIsBrandElement
(BooleanType value) setIsOverTheCounter
(boolean value) setManufacturer
(Reference value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) protected Medication
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
code
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. -
status
A code to indicate if the medication is in active use. -
isBrand
Set to true if the item is attributable to a specific manufacturer. -
isOverTheCounter
Set to true if the medication can be obtained without an order from a prescriber. -
manufacturer
Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. -
manufacturerTarget
The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.) -
form
Describes the form of the item. Powder; tablets; capsule. -
ingredient
Identifies a particular constituent of interest in the product. -
package_
Information that only applies to packages (not products). -
image
Photo(s) or graphic representation(s) of the medication. -
SP_INGREDIENT_CODE
Search parameter: ingredient-codeDescription: The product contained
Type: token
Path: Medication.ingredient.itemCodeableConcept
- See Also:
-
INGREDIENT_CODE
Fluent Client search parameter constant for ingredient-codeDescription: The product contained
Type: token
Path: Medication.ingredient.itemCodeableConcept
-
SP_CONTAINER
Search parameter: containerDescription: E.g. box, vial, blister-pack
Type: token
Path: Medication.package.container
- See Also:
-
CONTAINER
Fluent Client search parameter constant for containerDescription: E.g. box, vial, blister-pack
Type: token
Path: Medication.package.container
-
SP_PACKAGE_ITEM
Search parameter: package-itemDescription: The item in the package
Type: reference
Path: Medication.package.content.itemReference
- See Also:
-
PACKAGE_ITEM
Fluent Client search parameter constant for package-itemDescription: The item in the package
Type: reference
Path: Medication.package.content.itemReference
-
INCLUDE_PACKAGE_ITEM
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:package-item". -
SP_CODE
Search parameter: codeDescription: Codes that identify this medication
Type: token
Path: Medication.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Codes that identify this medication
Type: token
Path: Medication.code
-
SP_INGREDIENT
Search parameter: ingredientDescription: The product contained
Type: reference
Path: Medication.ingredient.itemReference
- See Also:
-
INGREDIENT
Fluent Client search parameter constant for ingredientDescription: The product contained
Type: reference
Path: Medication.ingredient.itemReference
-
INCLUDE_INGREDIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:ingredient". -
SP_FORM
Search parameter: formDescription: powder | tablets | capsule +
Type: token
Path: Medication.form
- See Also:
-
FORM
Fluent Client search parameter constant for formDescription: powder | tablets | capsule +
Type: token
Path: Medication.form
-
SP_PACKAGE_ITEM_CODE
Search parameter: package-item-codeDescription: The item in the package
Type: token
Path: Medication.package.content.itemCodeableConcept
- See Also:
-
PACKAGE_ITEM_CODE
Fluent Client search parameter constant for package-item-codeDescription: The item in the package
Type: token
Path: Medication.package.content.itemCodeableConcept
-
SP_MANUFACTURER
Search parameter: manufacturerDescription: Manufacturer of the item
Type: reference
Path: Medication.manufacturer
- See Also:
-
MANUFACTURER
Fluent Client search parameter constant for manufacturerDescription: Manufacturer of the item
Type: reference
Path: Medication.manufacturer
-
INCLUDE_MANUFACTURER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:manufacturer". -
SP_OVER_THE_COUNTER
Search parameter: over-the-counterDescription: True if medication does not require a prescription
Type: token
Path: Medication.isOverTheCounter
- See Also:
-
OVER_THE_COUNTER
Fluent Client search parameter constant for over-the-counterDescription: True if medication does not require a prescription
Type: token
Path: Medication.isOverTheCounter
-
SP_STATUS
Search parameter: statusDescription: active | inactive | entered-in-error
Type: token
Path: Medication.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: active | inactive | entered-in-error
Type: token
Path: Medication.status
-
-
Constructor Details
-
Medication
public Medication()Constructor
-
-
Method Details
-
getCode
- Returns:
code
(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.)
-
hasCode
-
setCode
- Parameters:
value
-code
(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.)
-
getStatusElement
- Returns:
status
(A code to indicate if the medication is in active use.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(A code to indicate if the medication is in active use.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- A code to indicate if the medication is in active use.
-
setStatus
- Parameters:
value
- A code to indicate if the medication is in active use.
-
getIsBrandElement
- Returns:
isBrand
(Set to true if the item is attributable to a specific manufacturer.). This is the underlying object with id, value and extensions. The accessor "getIsBrand" gives direct access to the value
-
hasIsBrandElement
-
hasIsBrand
-
setIsBrandElement
- Parameters:
value
-isBrand
(Set to true if the item is attributable to a specific manufacturer.). This is the underlying object with id, value and extensions. The accessor "getIsBrand" gives direct access to the value
-
getIsBrand
- Returns:
- Set to true if the item is attributable to a specific manufacturer.
-
setIsBrand
- Parameters:
value
- Set to true if the item is attributable to a specific manufacturer.
-
getIsOverTheCounterElement
- Returns:
isOverTheCounter
(Set to true if the medication can be obtained without an order from a prescriber.). This is the underlying object with id, value and extensions. The accessor "getIsOverTheCounter" gives direct access to the value
-
hasIsOverTheCounterElement
-
hasIsOverTheCounter
-
setIsOverTheCounterElement
- Parameters:
value
-isOverTheCounter
(Set to true if the medication can be obtained without an order from a prescriber.). This is the underlying object with id, value and extensions. The accessor "getIsOverTheCounter" gives direct access to the value
-
getIsOverTheCounter
- Returns:
- Set to true if the medication can be obtained without an order from a prescriber.
-
setIsOverTheCounter
- Parameters:
value
- Set to true if the medication can be obtained without an order from a prescriber.
-
getManufacturer
- Returns:
manufacturer
(Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
hasManufacturer
-
setManufacturer
- Parameters:
value
-manufacturer
(Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
getManufacturerTarget
- Returns:
manufacturer
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
setManufacturerTarget
- Parameters:
value
-manufacturer
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
-
getForm
- Returns:
form
(Describes the form of the item. Powder; tablets; capsule.)
-
hasForm
-
setForm
- Parameters:
value
-form
(Describes the form of the item. Powder; tablets; capsule.)
-
getIngredient
- Returns:
ingredient
(Identifies a particular constituent of interest in the product.)
-
setIngredient
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIngredient
-
addIngredient
-
addIngredient
-
getIngredientFirstRep
- Returns:
- The first repetition of repeating field
ingredient
, creating it if it does not already exist
-
getPackage
- Returns:
package_
(Information that only applies to packages (not products).)
-
hasPackage
-
setPackage
- Parameters:
value
-package_
(Information that only applies to packages (not products).)
-
getImage
- Returns:
image
(Photo(s) or graphic representation(s) of the medication.)
-
setImage
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasImage
-
addImage
-
addImage
-
getImageFirstRep
- Returns:
- The first repetition of repeating field
image
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-