Class Medication
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.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
public class Medication extends DomainResource
This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedication.MedicationBatchComponentstatic classMedication.MedicationIngredientComponentstatic classMedication.MedicationStatusCodesstatic classMedication.MedicationStatusCodesEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected Medication.MedicationBatchComponentbatchInformation that only applies to packages (not products).protected CodeableConceptcodeA code (or set of codes) that specify this medication, or a textual description if no code is available.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected CodeableConceptdoseFormDescribes the form of the item.static ca.uhn.fhir.rest.gclient.DateClientParamEXPIRATION_DATEFluent Client search parameter constant for expiration-datestatic ca.uhn.fhir.rest.gclient.TokenClientParamFORMFluent Client search parameter constant for formprotected List<Identifier>identifierBusiness identifier for this medication.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_INGREDIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MARKETINGAUTHORIZATIONHOLDERConstant for fluent queries to be used to add include statements.protected List<Medication.MedicationIngredientComponent>ingredientIdentifies a particular constituent of interest in the product.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINGREDIENTFluent Client search parameter constant for ingredientstatic ca.uhn.fhir.rest.gclient.TokenClientParamINGREDIENT_CODEFluent Client search parameter constant for ingredient-codestatic ca.uhn.fhir.rest.gclient.TokenClientParamLOT_NUMBERFluent Client search parameter constant for lot-numberprotected ReferencemarketingAuthorizationHolderDescribes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMARKETINGAUTHORIZATIONHOLDERFluent Client search parameter constant for marketingauthorizationholderstatic StringSP_CODESearch parameter: codestatic StringSP_EXPIRATION_DATESearch parameter: expiration-datestatic StringSP_FORMSearch parameter: formstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INGREDIENTSearch parameter: ingredientstatic StringSP_INGREDIENT_CODESearch parameter: ingredient-codestatic StringSP_LOT_NUMBERSearch parameter: lot-numberstatic StringSP_MARKETINGAUTHORIZATIONHOLDERSearch parameter: marketingauthorizationholderstatic StringSP_STATUSSearch parameter: statusprotected Enumeration<Medication.MedicationStatusCodes>statusA code to indicate if the medication is in active use.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected RatiototalVolumeWhen 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
-
-
Constructor Summary
Constructors Constructor Description Medication()Constructor
-
Method Summary
-
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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Business identifier for this medication.
-
code
protected CodeableConcept 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
protected Enumeration<Medication.MedicationStatusCodes> status
A code to indicate if the medication is in active use.
-
marketingAuthorizationHolder
protected Reference 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
protected CodeableConcept doseForm
Describes the form of the item. Powder; tablets; capsule.
-
totalVolume
protected Ratio 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
protected List<Medication.MedicationIngredientComponent> ingredient
Identifies a particular constituent of interest in the product.
-
batch
protected Medication.MedicationBatchComponent batch
Information that only applies to packages (not products).
-
SP_EXPIRATION_DATE
public static final String SP_EXPIRATION_DATE
Search parameter: expiration-dateDescription: Returns medications in a batch with this expiration date
Type: date
Path: Medication.batch.expirationDate
- See Also:
- Constant Field Values
-
EXPIRATION_DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam 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
public static final String SP_FORM
Search parameter: formDescription: Returns medications for a specific dose form
Type: token
Path: null
- See Also:
- Constant Field Values
-
FORM
public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORM
Fluent Client search parameter constant for formDescription: Returns medications for a specific dose form
Type: token
Path: null
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Returns medications with this external identifier
Type: token
Path: Medication.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Returns medications with this external identifier
Type: token
Path: Medication.identifier
-
SP_INGREDIENT_CODE
public static final String SP_INGREDIENT_CODE
Search parameter: ingredient-codeDescription: Returns medications for this ingredient code
Type: token
Path: Medication.ingredient.item.concept
- See Also:
- Constant Field Values
-
INGREDIENT_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_INGREDIENT
Search parameter: ingredientDescription: Returns medications for this ingredient reference
Type: reference
Path: Medication.ingredient.item.reference
- See Also:
- Constant Field Values
-
INGREDIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INGREDIENT
Fluent Client search parameter constant for ingredientDescription: Returns medications for this ingredient reference
Type: reference
Path: Medication.ingredient.item.reference
-
INCLUDE_INGREDIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_INGREDIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:ingredient".
-
SP_LOT_NUMBER
public static final String SP_LOT_NUMBER
Search parameter: lot-numberDescription: Returns medications in a batch with this lot number
Type: token
Path: Medication.batch.lotNumber
- See Also:
- Constant Field Values
-
LOT_NUMBER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_MARKETINGAUTHORIZATIONHOLDER
Search parameter: marketingauthorizationholderDescription: Returns medications made or sold for this marketing authorization holder
Type: reference
Path: Medication.marketingAuthorizationHolder
- See Also:
- Constant Field Values
-
MARKETINGAUTHORIZATIONHOLDER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_MARKETINGAUTHORIZATIONHOLDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:marketingauthorizationholder".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Returns medications for this status
Type: token
Path: Medication.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Returns medications for this status
Type: token
Path: Medication.status
-
SP_CODE
public static final String 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:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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 Detail
-
Medication
public Medication()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifier for this medication.)
-
setIdentifier
public Medication setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Medication addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getCode
public CodeableConcept 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
public boolean hasCode()
-
setCode
public Medication setCode(CodeableConcept value)
- 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
public Enumeration<Medication.MedicationStatusCodes> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Medication setStatusElement(Enumeration<Medication.MedicationStatusCodes> value)
- 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
public Medication.MedicationStatusCodes getStatus()
- Returns:
- A code to indicate if the medication is in active use.
-
setStatus
public Medication setStatus(Medication.MedicationStatusCodes value)
- Parameters:
value- A code to indicate if the medication is in active use.
-
getMarketingAuthorizationHolder
public Reference 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
public boolean hasMarketingAuthorizationHolder()
-
setMarketingAuthorizationHolder
public Medication setMarketingAuthorizationHolder(Reference value)
- 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
public CodeableConcept getDoseForm()
- Returns:
doseForm(Describes the form of the item. Powder; tablets; capsule.)
-
hasDoseForm
public boolean hasDoseForm()
-
setDoseForm
public Medication setDoseForm(CodeableConcept value)
- Parameters:
value-doseForm(Describes the form of the item. Powder; tablets; capsule.)
-
getTotalVolume
public Ratio 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
public boolean hasTotalVolume()
-
setTotalVolume
public Medication setTotalVolume(Ratio value)
- 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
public List<Medication.MedicationIngredientComponent> getIngredient()
- Returns:
ingredient(Identifies a particular constituent of interest in the product.)
-
setIngredient
public Medication setIngredient(List<Medication.MedicationIngredientComponent> theIngredient)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIngredient
public boolean hasIngredient()
-
addIngredient
public Medication.MedicationIngredientComponent addIngredient()
-
addIngredient
public Medication addIngredient(Medication.MedicationIngredientComponent t)
-
getIngredientFirstRep
public Medication.MedicationIngredientComponent getIngredientFirstRep()
- Returns:
- The first repetition of repeating field
ingredient, creating it if it does not already exist {3}
-
getBatch
public Medication.MedicationBatchComponent getBatch()
- Returns:
batch(Information that only applies to packages (not products).)
-
hasBatch
public boolean hasBatch()
-
setBatch
public Medication setBatch(Medication.MedicationBatchComponent value)
- Parameters:
value-batch(Information that only applies to packages (not products).)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Medication copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Medication dst)
-
typedCopy
protected Medication typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-