Package org.hl7.fhir.r5.model

Class ClinicalUseDefinition

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.ClinicalUseDefinition

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

A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent
static class	ClinicalUseDefinition.ClinicalUseDefinitionContraindicationOtherTherapyComponent
static class	ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent
static class	ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent
static class	ClinicalUseDefinition.ClinicalUseDefinitionInteractionInteractantComponent
static enum	ClinicalUseDefinition.ClinicalUseDefinitionType
static class	ClinicalUseDefinition.ClinicalUseDefinitionTypeEnumFactory
static class	ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent
static class	ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent

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 List<CodeableConcept>	category	A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".
protected ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent	contraindication	Specifics for when this is a contraindication.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTRAINDICATION	Fluent Client search parameter constant for contraindication
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTRAINDICATION_REFERENCE	Fluent Client search parameter constant for contraindication-reference
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EFFECT	Fluent Client search parameter constant for effect
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	EFFECT_REFERENCE	Fluent Client search parameter constant for effect-reference
protected List<Identifier>	identifier	Business identifier for this issue.
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_CONTRAINDICATION_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_EFFECT_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INDICATION_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRODUCT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent	indication	Specifics for when this is an indication.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INDICATION	Fluent Client search parameter constant for indication
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INDICATION_REFERENCE	Fluent Client search parameter constant for indication-reference
protected ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent	interaction	Specifics for when this is an interaction.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INTERACTION	Fluent Client search parameter constant for interaction
protected List<CanonicalType>	library	Logic used by the clinical use definition.
protected List<Reference>	population	The population group to which this applies.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRODUCT	Fluent Client search parameter constant for product
static final String	SP_CONTRAINDICATION	Search parameter: contraindication
static final String	SP_CONTRAINDICATION_REFERENCE	Search parameter: contraindication-reference
static final String	SP_EFFECT	Search parameter: effect
static final String	SP_EFFECT_REFERENCE	Search parameter: effect-reference
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INDICATION	Search parameter: indication
static final String	SP_INDICATION_REFERENCE	Search parameter: indication-reference
static final String	SP_INTERACTION	Search parameter: interaction
static final String	SP_PRODUCT	Search parameter: product
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_TYPE	Search parameter: type
protected CodeableConcept	status	Whether this is a current issue or one that has been retired etc.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<Reference>	subject	The medication, product, substance, device, procedure etc.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType>	type	indication | contraindication | interaction | undesirable-effect | warning.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent	undesirableEffect	Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.
protected ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent	warning	A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user.

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
ClinicalUseDefinition()	Constructor
ClinicalUseDefinition(ClinicalUseDefinition.ClinicalUseDefinitionType type)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addCategory()
ClinicalUseDefinition	addCategory(CodeableConcept t)
Base	addChild(String name)
Identifier	addIdentifier()
ClinicalUseDefinition	addIdentifier(Identifier t)
ClinicalUseDefinition	addLibrary(String value)
CanonicalType	addLibraryElement()
Reference	addPopulation()
ClinicalUseDefinition	addPopulation(Reference t)
Reference	addSubject()
ClinicalUseDefinition	addSubject(Reference t)
ClinicalUseDefinition	copy()
void	copyValues(ClinicalUseDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent	getContraindication()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent	getIndication()
ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent	getInteraction()
List<CanonicalType>	getLibrary()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Reference>	getPopulation()
Reference	getPopulationFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getStatus()
List<Reference>	getSubject()
Reference	getSubjectFirstRep()
ClinicalUseDefinition.ClinicalUseDefinitionType	getType()
Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent	getUndesirableEffect()
ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent	getWarning()
boolean	hasCategory()
boolean	hasContraindication()
boolean	hasIdentifier()
boolean	hasIndication()
boolean	hasInteraction()
boolean	hasLibrary()
boolean	hasLibrary(String value)
boolean	hasPopulation()
boolean	hasStatus()
boolean	hasSubject()
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUndesirableEffect()
boolean	hasWarning()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ClinicalUseDefinition	setCategory(List<CodeableConcept> theCategory)
ClinicalUseDefinition	setContraindication(ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent value)
ClinicalUseDefinition	setIdentifier(List<Identifier> theIdentifier)
ClinicalUseDefinition	setIndication(ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent value)
ClinicalUseDefinition	setInteraction(ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent value)
ClinicalUseDefinition	setLibrary(List<CanonicalType> theLibrary)
ClinicalUseDefinition	setPopulation(List<Reference> thePopulation)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ClinicalUseDefinition	setStatus(CodeableConcept value)
ClinicalUseDefinition	setSubject(List<Reference> theSubject)
ClinicalUseDefinition	setType(ClinicalUseDefinition.ClinicalUseDefinitionType value)
ClinicalUseDefinition	setTypeElement(Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType> value)
ClinicalUseDefinition	setUndesirableEffect(ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent value)
ClinicalUseDefinition	setWarning(ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent value)
protected ClinicalUseDefinition	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, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, 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, 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

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 issue.

type

protected Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType> type

indication | contraindication | interaction | undesirable-effect | warning.

category

protected List<CodeableConcept> category

A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".

subject

protected List<Reference> subject

The medication, product, substance, device, procedure etc. for which this is an indication.

status

protected CodeableConcept status

Whether this is a current issue or one that has been retired etc.

contraindication

protected ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent contraindication

Specifics for when this is a contraindication.

indication

protected ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent indication

Specifics for when this is an indication.

interaction

protected ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent interaction

Specifics for when this is an interaction.

population

protected List<Reference> population

The population group to which this applies.

library

protected List<CanonicalType> library

Logic used by the clinical use definition.

undesirableEffect

protected ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent undesirableEffect

Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.

warning

protected ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent warning

A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.

SP_CONTRAINDICATION_REFERENCE

public static final String SP_CONTRAINDICATION_REFERENCE

Search parameter: contraindication-reference

Description: The situation that is being documented as contraindicating against this item, as a reference
Type: reference
Path: ClinicalUseDefinition.contraindication.diseaseSymptomProcedure.reference

See Also:

• Constant Field Values

CONTRAINDICATION_REFERENCE

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

Fluent Client search parameter constant for contraindication-reference

Description: The situation that is being documented as contraindicating against this item, as a reference
Type: reference
Path: ClinicalUseDefinition.contraindication.diseaseSymptomProcedure.reference

INCLUDE_CONTRAINDICATION_REFERENCE

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseDefinition:contraindication-reference".

SP_CONTRAINDICATION

public static final String SP_CONTRAINDICATION

Search parameter: contraindication

Description: The situation that is being documented as contraindicating against this item, as a code
Type: token
Path: ClinicalUseDefinition.contraindication.diseaseSymptomProcedure.concept

See Also:

• Constant Field Values

CONTRAINDICATION

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

Fluent Client search parameter constant for contraindication

Description: The situation that is being documented as contraindicating against this item, as a code
Type: token
Path: ClinicalUseDefinition.contraindication.diseaseSymptomProcedure.concept

SP_EFFECT_REFERENCE

public static final String SP_EFFECT_REFERENCE

Search parameter: effect-reference

Description: The situation in which the undesirable effect may manifest, as a reference
Type: reference
Path: ClinicalUseDefinition.undesirableEffect.symptomConditionEffect.reference

See Also:

• Constant Field Values

EFFECT_REFERENCE

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

Fluent Client search parameter constant for effect-reference

Description: The situation in which the undesirable effect may manifest, as a reference
Type: reference
Path: ClinicalUseDefinition.undesirableEffect.symptomConditionEffect.reference

INCLUDE_EFFECT_REFERENCE

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseDefinition:effect-reference".

SP_EFFECT

public static final String SP_EFFECT

Search parameter: effect

Description: The situation in which the undesirable effect may manifest, as a code
Type: token
Path: ClinicalUseDefinition.undesirableEffect.symptomConditionEffect.concept

See Also:

• Constant Field Values

EFFECT

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

Fluent Client search parameter constant for effect

Description: The situation in which the undesirable effect may manifest, as a code
Type: token
Path: ClinicalUseDefinition.undesirableEffect.symptomConditionEffect.concept

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Business identifier for this issue
Type: token
Path: ClinicalUseDefinition.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: Business identifier for this issue
Type: token
Path: ClinicalUseDefinition.identifier

SP_INDICATION_REFERENCE

public static final String SP_INDICATION_REFERENCE

Search parameter: indication-reference

Description: The situation that is being documented as an indicaton for this item, as a reference
Type: reference
Path: ClinicalUseDefinition.indication.diseaseSymptomProcedure.reference

See Also:

• Constant Field Values

INDICATION_REFERENCE

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

Fluent Client search parameter constant for indication-reference

Description: The situation that is being documented as an indicaton for this item, as a reference
Type: reference
Path: ClinicalUseDefinition.indication.diseaseSymptomProcedure.reference

INCLUDE_INDICATION_REFERENCE

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseDefinition:indication-reference".

SP_INDICATION

public static final String SP_INDICATION

Search parameter: indication

Description: The situation that is being documented as an indicaton for this item, as a code
Type: token
Path: ClinicalUseDefinition.indication.diseaseSymptomProcedure.concept

See Also:

• Constant Field Values

INDICATION

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

Fluent Client search parameter constant for indication

Description: The situation that is being documented as an indicaton for this item, as a code
Type: token
Path: ClinicalUseDefinition.indication.diseaseSymptomProcedure.concept

SP_INTERACTION

public static final String SP_INTERACTION

Search parameter: interaction

Description: The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction
Type: token
Path: ClinicalUseDefinition.interaction.type

See Also:

• Constant Field Values

INTERACTION

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

Fluent Client search parameter constant for interaction

Description: The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction
Type: token
Path: ClinicalUseDefinition.interaction.type

SP_PRODUCT

public static final String SP_PRODUCT

Search parameter: product

Description: The medicinal product for which this is a clinical usage issue
Type: reference
Path: ClinicalUseDefinition.subject.where(resolve() is MedicinalProductDefinition)

See Also:

• Constant Field Values

PRODUCT

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

Fluent Client search parameter constant for product

Description: The medicinal product for which this is a clinical usage issue
Type: reference
Path: ClinicalUseDefinition.subject.where(resolve() is MedicinalProductDefinition)

INCLUDE_PRODUCT

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

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: Whether this is a current issue or one that has been retired etc.
Type: token
Path: ClinicalUseDefinition.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: Whether this is a current issue or one that has been retired etc.
Type: token
Path: ClinicalUseDefinition.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: The resource for which this is a clinical usage issue
Type: reference
Path: ClinicalUseDefinition.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 resource for which this is a clinical usage issue
Type: reference
Path: ClinicalUseDefinition.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 "ClinicalUseDefinition:subject".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: indication | contraindication | interaction | undesirable-effect | warning
Type: token
Path: ClinicalUseDefinition.type

See Also:

• Constant Field Values

TYPE

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

Fluent Client search parameter constant for type

Description: indication | contraindication | interaction | undesirable-effect | warning
Type: token
Path: ClinicalUseDefinition.type

Constructor Details

ClinicalUseDefinition

public ClinicalUseDefinition()

Constructor

ClinicalUseDefinition

public ClinicalUseDefinition(ClinicalUseDefinition.ClinicalUseDefinitionType type)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Business identifier for this issue.)

setIdentifier

public ClinicalUseDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ClinicalUseDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getTypeElement

public Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType> getTypeElement()

Returns:

type (indication | contraindication | interaction | undesirable-effect | warning.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public ClinicalUseDefinition setTypeElement(Enumeration<ClinicalUseDefinition.ClinicalUseDefinitionType> value)

Parameters:

value - type (indication | contraindication | interaction | undesirable-effect | warning.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public ClinicalUseDefinition.ClinicalUseDefinitionType getType()

Returns:

indication | contraindication | interaction | undesirable-effect | warning.

setType

public ClinicalUseDefinition setType(ClinicalUseDefinition.ClinicalUseDefinitionType value)

Parameters:

value - indication | contraindication | interaction | undesirable-effect | warning.

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".)

setCategory

public ClinicalUseDefinition setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public ClinicalUseDefinition addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist {3}

getSubject

public List<Reference> getSubject()

Returns:

subject (The medication, product, substance, device, procedure etc. for which this is an indication.)

setSubject

public ClinicalUseDefinition setSubject(List<Reference> theSubject)

Returns:

Returns a reference to this for easy method chaining

hasSubject

public boolean hasSubject()

addSubject

public Reference addSubject()

addSubject

public ClinicalUseDefinition addSubject(Reference t)

getSubjectFirstRep

public Reference getSubjectFirstRep()

Returns:

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

getStatus

public CodeableConcept getStatus()

Returns:

status (Whether this is a current issue or one that has been retired etc.)

hasStatus

public boolean hasStatus()

setStatus

public ClinicalUseDefinition setStatus(CodeableConcept value)

Parameters:

value - status (Whether this is a current issue or one that has been retired etc.)

getContraindication

public ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent getContraindication()

Returns:

contraindication (Specifics for when this is a contraindication.)

hasContraindication

public boolean hasContraindication()

setContraindication

public ClinicalUseDefinition setContraindication(ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent value)

Parameters:

value - contraindication (Specifics for when this is a contraindication.)

getIndication

public ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent getIndication()

Returns:

indication (Specifics for when this is an indication.)

hasIndication

public boolean hasIndication()

setIndication

public ClinicalUseDefinition setIndication(ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent value)

Parameters:

value - indication (Specifics for when this is an indication.)

getInteraction

public ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent getInteraction()

Returns:

interaction (Specifics for when this is an interaction.)

hasInteraction

public boolean hasInteraction()

setInteraction

public ClinicalUseDefinition setInteraction(ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent value)

Parameters:

value - interaction (Specifics for when this is an interaction.)

getPopulation

public List<Reference> getPopulation()

Returns:

population (The population group to which this applies.)

setPopulation

public ClinicalUseDefinition setPopulation(List<Reference> thePopulation)

Returns:

Returns a reference to this for easy method chaining

hasPopulation

public boolean hasPopulation()

addPopulation

public Reference addPopulation()

addPopulation

public ClinicalUseDefinition addPopulation(Reference t)

getPopulationFirstRep

public Reference getPopulationFirstRep()

Returns:

The first repetition of repeating field population, creating it if it does not already exist {3}

getLibrary

public List<CanonicalType> getLibrary()

Returns:

library (Logic used by the clinical use definition.)

setLibrary

public ClinicalUseDefinition setLibrary(List<CanonicalType> theLibrary)

Returns:

Returns a reference to this for easy method chaining

hasLibrary

public boolean hasLibrary()

addLibraryElement

public CanonicalType addLibraryElement()

Returns:

library (Logic used by the clinical use definition.)

addLibrary

public ClinicalUseDefinition addLibrary(String value)

Parameters:

value - library (Logic used by the clinical use definition.)

hasLibrary

public boolean hasLibrary(String value)

Parameters:

value - library (Logic used by the clinical use definition.)

getUndesirableEffect

public ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent getUndesirableEffect()

Returns:

undesirableEffect (Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.)

hasUndesirableEffect

public boolean hasUndesirableEffect()

setUndesirableEffect

public ClinicalUseDefinition setUndesirableEffect(ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent value)

Parameters:

value - undesirableEffect (Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.)

getWarning

public ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent getWarning()

Returns:

warning (A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.)

hasWarning

public boolean hasWarning()

setWarning

public ClinicalUseDefinition setWarning(ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent value)

Parameters:

value - warning (A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.)

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 ClinicalUseDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(ClinicalUseDefinition dst)

typedCopy

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