Package org.hl7.fhir.r4.model

Class MedicinalProductInteraction

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MedicinalProductInteraction

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 MedicinalProductInteraction
extends DomainResource

The interactions of the medicinal product with other medicinal products, or other forms of interactions.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected StringType	description	The interaction described.
protected CodeableConcept	effect	The effect of the interaction, for example "reduced gastric absorption of primary medication".
protected CodeableConcept	incidence	The incidence of the interaction, e.g.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent>	interactant	The specific medication, food or laboratory test that interacts.
protected CodeableConcept	management	Actions for managing the interaction.
static final String	SP_SUBJECT	Search parameter: subject
protected List<Reference>	subject	The medication for which this is a described interaction.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected List<Resource>	subjectTarget	The actual objects that are the target of the reference (The medication for which this is a described interaction.)
protected CodeableConcept	type	The type of the interaction e.g.

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.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
MedicinalProductInteraction()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent	addInteractant()
MedicinalProductInteraction	addInteractant(MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent t)
Reference	addSubject()
MedicinalProductInteraction	addSubject(Reference t)
MedicinalProductInteraction	copy()
void	copyValues(MedicinalProductInteraction dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getDescription()
StringType	getDescriptionElement()
CodeableConcept	getEffect()
CodeableConcept	getIncidence()
List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent>	getInteractant()
MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent	getInteractantFirstRep()
CodeableConcept	getManagement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<Reference>	getSubject()
Reference	getSubjectFirstRep()
List<Resource>	getSubjectTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEffect()
boolean	hasIncidence()
boolean	hasInteractant()
boolean	hasManagement()
boolean	hasSubject()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
MedicinalProductInteraction	setDescription(String value)
MedicinalProductInteraction	setDescriptionElement(StringType value)
MedicinalProductInteraction	setEffect(CodeableConcept value)
MedicinalProductInteraction	setIncidence(CodeableConcept value)
MedicinalProductInteraction	setInteractant(List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent> theInteractant)
MedicinalProductInteraction	setManagement(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicinalProductInteraction	setSubject(List<Reference> theSubject)
MedicinalProductInteraction	setType(CodeableConcept value)
protected MedicinalProductInteraction	typedCopy()

Methods inherited from class org.hl7.fhir.r4.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.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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, isDeleted, setId

Field Details

subject

protected List<Reference> subject

The medication for which this is a described interaction.

subjectTarget

protected List<Resource> subjectTarget

The actual objects that are the target of the reference (The medication for which this is a described interaction.)

description

protected StringType description

The interaction described.

interactant

protected List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent> interactant

The specific medication, food or laboratory test that interacts.

type

protected CodeableConcept type

The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.

effect

protected CodeableConcept effect

The effect of the interaction, for example "reduced gastric absorption of primary medication".

incidence

protected CodeableConcept incidence

The incidence of the interaction, e.g. theoretical, observed.

management

protected CodeableConcept management

Actions for managing the interaction.

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: The medication for which this is an interaction
Type: reference
Path: MedicinalProductInteraction.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The medication for which this is an interaction
Type: reference
Path: MedicinalProductInteraction.subject

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicinalProductInteraction:subject".

Constructor Details

MedicinalProductInteraction

public MedicinalProductInteraction()

Constructor

Method Details

getSubject

public List<Reference> getSubject()

Returns:

subject (The medication for which this is a described interaction.)

setSubject

public MedicinalProductInteraction setSubject(List<Reference> theSubject)

Returns:

Returns a reference to this for easy method chaining

hasSubject

public boolean hasSubject()

addSubject

public Reference addSubject()

addSubject

public MedicinalProductInteraction addSubject(Reference t)

getSubjectFirstRep

public Reference getSubjectFirstRep()

Returns:

The first repetition of repeating field subject, creating it if it does not already exist

getSubjectTarget

@Deprecated
public List<Resource> getSubjectTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (The interaction described.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public MedicinalProductInteraction setDescriptionElement(StringType value)

Parameters:

value - description (The interaction described.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

The interaction described.

setDescription

public MedicinalProductInteraction setDescription(String value)

Parameters:

value - The interaction described.

getInteractant

public List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent> getInteractant()

Returns:

interactant (The specific medication, food or laboratory test that interacts.)

setInteractant

public MedicinalProductInteraction setInteractant(List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent> theInteractant)

Returns:

Returns a reference to this for easy method chaining

hasInteractant

public boolean hasInteractant()

addInteractant

public MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent addInteractant()

addInteractant

public MedicinalProductInteraction addInteractant(MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent t)

getInteractantFirstRep

public MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent getInteractantFirstRep()

Returns:

The first repetition of repeating field interactant, creating it if it does not already exist

getType

public CodeableConcept getType()

Returns:

type (The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.)

hasType

public boolean hasType()

setType

public MedicinalProductInteraction setType(CodeableConcept value)

Parameters:

value - type (The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.)

getEffect

public CodeableConcept getEffect()

Returns:

effect (The effect of the interaction, for example "reduced gastric absorption of primary medication".)

hasEffect

public boolean hasEffect()

setEffect

public MedicinalProductInteraction setEffect(CodeableConcept value)

Parameters:

value - effect (The effect of the interaction, for example "reduced gastric absorption of primary medication".)

getIncidence

public CodeableConcept getIncidence()

Returns:

incidence (The incidence of the interaction, e.g. theoretical, observed.)

hasIncidence

public boolean hasIncidence()

setIncidence

public MedicinalProductInteraction setIncidence(CodeableConcept value)

Parameters:

value - incidence (The incidence of the interaction, e.g. theoretical, observed.)

getManagement

public CodeableConcept getManagement()

Returns:

management (Actions for managing the interaction.)

hasManagement

public boolean hasManagement()

setManagement

public MedicinalProductInteraction setManagement(CodeableConcept value)

Parameters:

value - management (Actions for managing the interaction.)

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

copy

public MedicinalProductInteraction copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(MedicinalProductInteraction dst)

typedCopy

protected MedicinalProductInteraction 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