Package org.hl7.fhir.r5.model

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 class	Medication.MedicationBatchComponent
static class	Medication.MedicationIngredientComponent
static enum	Medication.MedicationStatusCodes
static class	Medication.MedicationStatusCodesEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Medication.MedicationBatchComponent	batch	Information that only applies to packages (not products).
protected CodeableConcept	code	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	CODE	Fluent Client search parameter constant for code
protected Reference	definition	A reference to a knowledge resource that provides more information about this medication.
protected CodeableConcept	doseForm	Describes the form of the item.
static final ca.uhn.fhir.rest.gclient.DateClientParam	EXPIRATION_DATE	Fluent Client search parameter constant for expiration-date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FORM	Fluent Client search parameter constant for form
protected List<Identifier>	identifier	Business identifier for this medication.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_INGREDIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MARKETINGAUTHORIZATIONHOLDER	Constant for fluent queries to be used to add include statements.
protected List<Medication.MedicationIngredientComponent>	ingredient	Identifies a particular constituent of interest in the product.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INGREDIENT	Fluent Client search parameter constant for ingredient
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INGREDIENT_CODE	Fluent Client search parameter constant for ingredient-code
static final ca.uhn.fhir.rest.gclient.TokenClientParam	LOT_NUMBER	Fluent Client search parameter constant for lot-number
protected Reference	marketingAuthorizationHolder	The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MARKETINGAUTHORIZATIONHOLDER	Fluent Client search parameter constant for marketingauthorizationholder
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERIAL_NUMBER	Fluent Client search parameter constant for serial-number
static final String	SP_CODE	Search parameter: code
static final String	SP_EXPIRATION_DATE	Search parameter: expiration-date
static final String	SP_FORM	Search parameter: form
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INGREDIENT	Search parameter: ingredient
static final String	SP_INGREDIENT_CODE	Search parameter: ingredient-code
static final String	SP_LOT_NUMBER	Search parameter: lot-number
static final String	SP_MARKETINGAUTHORIZATIONHOLDER	Search parameter: marketingauthorizationholder
static final String	SP_SERIAL_NUMBER	Search parameter: serial-number
static final String	SP_STATUS	Search parameter: status
protected Enumeration<Medication.MedicationStatusCodes>	status	A code to indicate if the medication is in active use.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Quantity	totalVolume	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, 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

Constructors

Constructor	Description
Medication()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
Medication	addIdentifier(Identifier t)
Medication.MedicationIngredientComponent	addIngredient()
Medication	addIngredient(Medication.MedicationIngredientComponent t)
Medication	copy()
void	copyValues(Medication dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Medication.MedicationBatchComponent	getBatch()
CodeableConcept	getCode()
Reference	getDefinition()
CodeableConcept	getDoseForm()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Medication.MedicationIngredientComponent>	getIngredient()
Medication.MedicationIngredientComponent	getIngredientFirstRep()
Reference	getMarketingAuthorizationHolder()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Medication.MedicationStatusCodes	getStatus()
Enumeration<Medication.MedicationStatusCodes>	getStatusElement()
Quantity	getTotalVolume()
String[]	getTypesForProperty(int hash, String name)
boolean	hasBatch()
boolean	hasCode()
boolean	hasDefinition()
boolean	hasDoseForm()
boolean	hasIdentifier()
boolean	hasIngredient()
boolean	hasMarketingAuthorizationHolder()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTotalVolume()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Medication	setBatch(Medication.MedicationBatchComponent value)
Medication	setCode(CodeableConcept value)
Medication	setDefinition(Reference value)
Medication	setDoseForm(CodeableConcept value)
Medication	setIdentifier(List<Identifier> theIdentifier)
Medication	setIngredient(List<Medication.MedicationIngredientComponent> theIngredient)
Medication	setMarketingAuthorizationHolder(Reference value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Medication	setStatus(Medication.MedicationStatusCodes value)
Medication	setStatusElement(Enumeration<Medication.MedicationStatusCodes> value)
Medication	setTotalVolume(Quantity value)
protected Medication	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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

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

The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).

doseForm

protected CodeableConcept doseForm

Describes the form of the item. Powder; tablets; capsule.

totalVolume

protected Quantity 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).

definition

protected Reference definition

A reference to a knowledge resource that provides more information about this medication.

SP_EXPIRATION_DATE

public static final String SP_EXPIRATION_DATE

Search parameter: expiration-date

Description: 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-date

Description: 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: form

Description: 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 form

Description: Returns medications for a specific dose form
Type: token
Path: null

SP_INGREDIENT_CODE

public static final String SP_INGREDIENT_CODE

Search parameter: ingredient-code

Description: 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-code

Description: Returns medications for this ingredient code
Type: token
Path: Medication.ingredient.item.concept

SP_INGREDIENT

public static final String SP_INGREDIENT

Search parameter: ingredient

Description: 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 ingredient

Description: 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-number

Description: 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-number

Description: 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: marketingauthorizationholder

Description: 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 marketingauthorizationholder

Description: 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_SERIAL_NUMBER

public static final String SP_SERIAL_NUMBER

Search parameter: serial-number

Description: Returns medications in a batch with this lot number
Type: token
Path: Medication.identifier

See Also:

• Constant Field Values

SERIAL_NUMBER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERIAL_NUMBER

Fluent Client search parameter constant for serial-number

Description: Returns medications in a batch with this lot number
Type: token
Path: Medication.identifier

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: 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 status

Description: Returns medications for this status
Type: token
Path: Medication.status

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [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 [ImagingSelection](imagingselection.html): The imaging selection status [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 [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [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 [ImagingSelection](imagingselection.html): The imaging selection status [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 [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

Constructor Details

Medication

public Medication()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Business identifier for this medication.)

setIdentifier

public Medication setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for 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 (The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).)

hasMarketingAuthorizationHolder

public boolean hasMarketingAuthorizationHolder()

setMarketingAuthorizationHolder

public Medication setMarketingAuthorizationHolder(Reference value)

Parameters:

value - marketingAuthorizationHolder (The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).)

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 Quantity 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(Quantity 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 this for 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).)

getDefinition

public Reference getDefinition()

Returns:

definition (A reference to a knowledge resource that provides more information about this medication.)

hasDefinition

public boolean hasDefinition()

setDefinition

public Medication setDefinition(Reference value)

Parameters:

value - definition (A reference to a knowledge resource that provides more information about this medication.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class DomainResource

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 class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Medication copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Medication dst)

typedCopy

protected Medication typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource