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 DomainResource
A 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 Summary
Nested Classes Modifier and Type Class Description static class
ClinicalUseDefinition.Builder
static class
ClinicalUseDefinition.Contraindication
Specifics for when this is a contraindication.static class
ClinicalUseDefinition.Indication
Specifics for when this is an indication.static class
ClinicalUseDefinition.Interaction
Specifics for when this is an interaction.static class
ClinicalUseDefinition.UndesirableEffect
Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.static class
ClinicalUseDefinition.Warning
A 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.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ClinicalUseDefinition.Builder
builder()
boolean
equals(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.Contraindication
getContraindication()
Specifics for when this is a contraindication.java.util.List<Identifier>
getIdentifier()
Business identifier for this issue.ClinicalUseDefinition.Indication
getIndication()
Specifics for when this is an indication.ClinicalUseDefinition.Interaction
getInteraction()
Specifics for when this is an interaction.java.util.List<Reference>
getPopulation()
The population group to which this applies.CodeableConcept
getStatus()
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.ClinicalUseDefinitionType
getType()
indication | contraindication | interaction | undesirable-effect | warning.ClinicalUseDefinition.UndesirableEffect
getUndesirableEffect()
Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.ClinicalUseDefinition.Warning
getWarning()
A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user.boolean
hasChildren()
int
hashCode()
ClinicalUseDefinition.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Business identifier for this issue.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getType
public ClinicalUseDefinitionType getType()
indication | contraindication | interaction | undesirable-effect | warning.- Returns:
- An immutable object of type
ClinicalUseDefinitionType
that is non-null.
-
getCategory
public 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
CodeableConcept
that may be empty.
-
getSubject
public java.util.List<Reference> getSubject()
The medication or procedure for which this is an indication.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getStatus
public CodeableConcept getStatus()
Whether this is a current issue or one that has been retired etc.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getContraindication
public ClinicalUseDefinition.Contraindication getContraindication()
Specifics for when this is a contraindication.- Returns:
- An immutable object of type
ClinicalUseDefinition.Contraindication
that may be null.
-
getIndication
public ClinicalUseDefinition.Indication getIndication()
Specifics for when this is an indication.- Returns:
- An immutable object of type
ClinicalUseDefinition.Indication
that may be null.
-
getInteraction
public ClinicalUseDefinition.Interaction getInteraction()
Specifics for when this is an interaction.- Returns:
- An immutable object of type
ClinicalUseDefinition.Interaction
that may be null.
-
getPopulation
public java.util.List<Reference> getPopulation()
The population group to which this applies.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getUndesirableEffect
public 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.UndesirableEffect
that may be null.
-
getWarning
public 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.Warning
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept 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:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ClinicalUseDefinition.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static ClinicalUseDefinition.Builder builder()
-
-