Class ClinicalUseDefinition
- java.lang.Object
- 
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
- 
- org.linuxforhealth.fhir.model.resource.Resource
- 
- org.linuxforhealth.fhir.model.resource.DomainResource
- 
- org.linuxforhealth.fhir.model.resource.ClinicalUseDefinition
 
 
 
 
- 
- All Implemented Interfaces:
- Visitable
 
 @Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class ClinicalUseDefinition extends DomainResourceA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.Maturity level: FMM1 (Trial Use) 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classClinicalUseDefinition.Builderstatic classClinicalUseDefinition.ContraindicationSpecifics for when this is a contraindication.static classClinicalUseDefinition.IndicationSpecifics for when this is an indication.static classClinicalUseDefinition.InteractionSpecifics for when this is an interaction.static classClinicalUseDefinition.UndesirableEffectDescribe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.static classClinicalUseDefinition.WarningA critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user.
 - 
Field Summary- 
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResourcecontained, extension, modifierExtension, text
 
- 
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static ClinicalUseDefinition.Builderbuilder()booleanequals(java.lang.Object obj)java.util.List<CodeableConcept>getCategory()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".ClinicalUseDefinition.ContraindicationgetContraindication()Specifics for when this is a contraindication.java.util.List<Identifier>getIdentifier()Business identifier for this issue.ClinicalUseDefinition.IndicationgetIndication()Specifics for when this is an indication.ClinicalUseDefinition.InteractiongetInteraction()Specifics for when this is an interaction.java.util.List<Reference>getPopulation()The population group to which this applies.CodeableConceptgetStatus()Whether this is a current issue or one that has been retired etc.java.util.List<Reference>getSubject()The medication or procedure for which this is an indication.ClinicalUseDefinitionTypegetType()indication | contraindication | interaction | undesirable-effect | warning.ClinicalUseDefinition.UndesirableEffectgetUndesirableEffect()Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.ClinicalUseDefinition.WarninggetWarning()A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user.booleanhasChildren()inthashCode()ClinicalUseDefinition.BuildertoBuilder()Create a new Builder from the contents of this Resource- 
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResourcegetContained, getExtension, getModifierExtension, getText
 - 
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resourceas, getId, getImplicitRules, getLanguage, getMeta, is
 
- 
 
- 
- 
- 
Method Detail- 
getIdentifierpublic java.util.List<Identifier> getIdentifier() Business identifier for this issue.- Returns:
- An unmodifiable list containing immutable objects of type Identifierthat may be empty.
 
 - 
getTypepublic ClinicalUseDefinitionType getType() indication | contraindication | interaction | undesirable-effect | warning.- Returns:
- An immutable object of type ClinicalUseDefinitionTypethat is non-null.
 
 - 
getCategorypublic java.util.List<CodeableConcept> getCategory() 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".- Returns:
- An unmodifiable list containing immutable objects of type CodeableConceptthat may be empty.
 
 - 
getSubjectpublic java.util.List<Reference> getSubject() The medication or procedure for which this is an indication.- Returns:
- An unmodifiable list containing immutable objects of type Referencethat may be empty.
 
 - 
getStatuspublic CodeableConcept getStatus() Whether this is a current issue or one that has been retired etc.- Returns:
- An immutable object of type CodeableConceptthat may be null.
 
 - 
getContraindicationpublic ClinicalUseDefinition.Contraindication getContraindication() Specifics for when this is a contraindication.- Returns:
- An immutable object of type ClinicalUseDefinition.Contraindicationthat may be null.
 
 - 
getIndicationpublic ClinicalUseDefinition.Indication getIndication() Specifics for when this is an indication.- Returns:
- An immutable object of type ClinicalUseDefinition.Indicationthat may be null.
 
 - 
getInteractionpublic ClinicalUseDefinition.Interaction getInteraction() Specifics for when this is an interaction.- Returns:
- An immutable object of type ClinicalUseDefinition.Interactionthat may be null.
 
 - 
getPopulationpublic java.util.List<Reference> getPopulation() The population group to which this applies.- Returns:
- An unmodifiable list containing immutable objects of type Referencethat may be empty.
 
 - 
getUndesirableEffectpublic ClinicalUseDefinition.UndesirableEffect getUndesirableEffect() Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.- Returns:
- An immutable object of type ClinicalUseDefinition.UndesirableEffectthat may be null.
 
 - 
getWarningpublic ClinicalUseDefinition.Warning getWarning() 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'.- Returns:
- An immutable object of type ClinicalUseDefinition.Warningthat may be null.
 
 - 
hasChildrenpublic boolean hasChildren() - Overrides:
- hasChildrenin class- DomainResource
 
 - 
acceptpublic void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
- acceptin interface- Visitable
- Specified by:
- acceptin class- AbstractVisitable
- Parameters:
- elementName- the name of the element in the context of this visit
- elementIndex- the index of the element in a list or -1 if it is not contained within a List
- visitor- the visitor to use
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
toBuilderpublic ClinicalUseDefinition.Builder toBuilder() Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
- toBuilderin class- DomainResource
 
 - 
builderpublic static ClinicalUseDefinition.Builder builder() 
 
- 
 
-