
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
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Medication.MedicationBatchComponent
Information that only applies to packages (not products).protected 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 codeprotected CodeableConcept
Describes the form of the item.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for expiration-datestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for formprotected List<Identifier>
Business identifier for this medication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic 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-codestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for lot-numberprotected Reference
Describes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for marketingauthorizationholderstatic final String
Search parameter: codestatic final String
Search parameter: expiration-datestatic final String
Search parameter: formstatic final String
Search parameter: identifierstatic final String
Search parameter: ingredientstatic final String
Search parameter: ingredient-codestatic final String
Search parameter: lot-numberstatic final String
Search parameter: marketingauthorizationholderstatic final String
Search parameter: statusprotected Enumeration<Medication.MedicationStatusCodes>
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 statusprotected Ratio
When the specified product code does not infer a package size, this is the specific amount of drug in the product.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(Medication dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getBatch()
getCode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
hasBatch()
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCode
(CodeableConcept value) setDoseForm
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setIngredient
(List<Medication.MedicationIngredientComponent> theIngredient) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setTotalVolume
(Ratio value) protected Medication
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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, setId
-
Field Details
-
identifier
Business identifier for this medication. -
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. -
marketingAuthorizationHolder
Describes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction. This might not be the company that physically manufactures the product. May be known as "Sponsor" and is commonly called "Manufacturer". -
doseForm
Describes the form of the item. Powder; tablets; capsule. -
totalVolume
When the specified product code does not infer a package size, this is the specific amount of drug in the 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.). -
ingredient
Identifies a particular constituent of interest in the product. -
batch
Information that only applies to packages (not products). -
SP_EXPIRATION_DATE
Search parameter: expiration-dateDescription: Returns medications in a batch with this expiration date
Type: date
Path: Medication.batch.expirationDate
- See Also:
-
EXPIRATION_DATE
Fluent Client search parameter constant for expiration-dateDescription: Returns medications in a batch with this expiration date
Type: date
Path: Medication.batch.expirationDate
-
SP_FORM
Search parameter: formDescription: Returns medications for a specific dose form
Type: token
Path: null
- See Also:
-
FORM
Fluent Client search parameter constant for formDescription: Returns medications for a specific dose form
Type: token
Path: null
-
SP_IDENTIFIER
Search parameter: identifierDescription: Returns medications with this external identifier
Type: token
Path: Medication.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Returns medications with this external identifier
Type: token
Path: Medication.identifier
-
SP_INGREDIENT_CODE
Search parameter: ingredient-codeDescription: Returns medications for this ingredient code
Type: token
Path: Medication.ingredient.item.concept
- See Also:
-
INGREDIENT_CODE
Fluent Client search parameter constant for ingredient-codeDescription: Returns medications for this ingredient code
Type: token
Path: Medication.ingredient.item.concept
-
SP_INGREDIENT
Search parameter: ingredientDescription: Returns medications for this ingredient reference
Type: reference
Path: Medication.ingredient.item.reference
- See Also:
-
INGREDIENT
Fluent Client search parameter constant for ingredientDescription: Returns medications for this ingredient reference
Type: reference
Path: Medication.ingredient.item.reference
-
INCLUDE_INGREDIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:ingredient". -
SP_LOT_NUMBER
Search parameter: lot-numberDescription: Returns medications in a batch with this lot number
Type: token
Path: Medication.batch.lotNumber
- See Also:
-
LOT_NUMBER
Fluent Client search parameter constant for lot-numberDescription: Returns medications in a batch with this lot number
Type: token
Path: Medication.batch.lotNumber
-
SP_MARKETINGAUTHORIZATIONHOLDER
Search parameter: marketingauthorizationholderDescription: Returns medications made or sold for this marketing authorization holder
Type: reference
Path: Medication.marketingAuthorizationHolder
- See Also:
-
MARKETINGAUTHORIZATIONHOLDER
Fluent Client search parameter constant for marketingauthorizationholderDescription: Returns medications made or sold for this marketing authorization holder
Type: reference
Path: Medication.marketingAuthorizationHolder
-
INCLUDE_MARKETINGAUTHORIZATIONHOLDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:marketingauthorizationholder". -
SP_STATUS
Search parameter: statusDescription: Returns medications for this status
Type: token
Path: Medication.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Returns medications for this status
Type: token
Path: Medication.status
-
SP_CODE
Search parameter: codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
-
-
Constructor Details
-
Medication
public Medication()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for this medication.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
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.
-
getMarketingAuthorizationHolder
- Returns:
marketingAuthorizationHolder
(Describes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction. This might not be the company that physically manufactures the product. May be known as "Sponsor" and is commonly called "Manufacturer".)
-
hasMarketingAuthorizationHolder
-
setMarketingAuthorizationHolder
- Parameters:
value
-marketingAuthorizationHolder
(Describes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction. This might not be the company that physically manufactures the product. May be known as "Sponsor" and is commonly called "Manufacturer".)
-
getDoseForm
- Returns:
doseForm
(Describes the form of the item. Powder; tablets; capsule.)
-
hasDoseForm
-
setDoseForm
- Parameters:
value
-doseForm
(Describes the form of the item. Powder; tablets; capsule.)
-
getTotalVolume
- Returns:
totalVolume
(When the specified product code does not infer a package size, this is the specific amount of drug in the 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.).)
-
hasTotalVolume
-
setTotalVolume
- Parameters:
value
-totalVolume
(When the specified product code does not infer a package size, this is the specific amount of drug in the 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.).)
-
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 {3}
-
getBatch
- Returns:
batch
(Information that only applies to packages (not products).)
-
hasBatch
-
setBatch
- Parameters:
value
-batch
(Information that only applies to packages (not products).)
-
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
-
copyValues
-
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
-