Class ClinicalUseIssue
- 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.ClinicalUseIssue
-
- 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 ClinicalUseIssue extends DomainResource
A single usage 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 classClinicalUseIssue.ClinicalUseIssueContraindicationComponentstatic classClinicalUseIssue.ClinicalUseIssueContraindicationOtherTherapyComponentstatic classClinicalUseIssue.ClinicalUseIssueIndicationComponentstatic classClinicalUseIssue.ClinicalUseIssueInteractionComponentstatic classClinicalUseIssue.ClinicalUseIssueInteractionInteractantComponentstatic classClinicalUseIssue.ClinicalUseIssueTypestatic classClinicalUseIssue.ClinicalUseIssueTypeEnumFactorystatic classClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent
-
Field Summary
Fields Modifier and Type Field Description protected ClinicalUseIssue.ClinicalUseIssueContraindicationComponentcontraindicationSpecifics for when this is a contraindication.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTRAINDICATIONFluent Client search parameter constant for contraindicationprotected MarkdownTypedescriptionGeneral description.static ca.uhn.fhir.rest.gclient.TokenClientParamEFFECTFluent Client search parameter constant for effectprotected List<Identifier>identifierBusiness identifier for this issue.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_PRODUCTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected ClinicalUseIssue.ClinicalUseIssueIndicationComponentindicationSpecifics for when this is an indication.static ca.uhn.fhir.rest.gclient.TokenClientParamINDICATIONFluent Client search parameter constant for indicationprotected ClinicalUseIssue.ClinicalUseIssueInteractionComponentinteractionSpecifics for when this is an interaction.static ca.uhn.fhir.rest.gclient.TokenClientParamINTERACTIONFluent Client search parameter constant for interactionprotected List<Population>populationThe population group to which this applies.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPRODUCTFluent Client search parameter constant for productstatic StringSP_CONTRAINDICATIONSearch parameter: contraindicationstatic StringSP_EFFECTSearch parameter: effectstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INDICATIONSearch parameter: indicationstatic StringSP_INTERACTIONSearch parameter: interactionstatic StringSP_PRODUCTSearch parameter: productstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typeprotected CodeableConceptstatusGeneral description.protected List<Reference>subjectThe medication or procedure for which this is an indication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected Enumeration<ClinicalUseIssue.ClinicalUseIssueType>typeindication | contraindication | interaction | undesirable-effect | other.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typeprotected ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponentundesirableEffectDescribe the undesirable effects of the medicinal 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
-
-
Constructor Summary
Constructors Constructor Description ClinicalUseIssue()ConstructorClinicalUseIssue(ClinicalUseIssue.ClinicalUseIssueType type)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.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.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Business identifier for this issue.
-
type
protected Enumeration<ClinicalUseIssue.ClinicalUseIssueType> type
indication | contraindication | interaction | undesirable-effect | other.
-
subject
protected List<Reference> subject
The medication or procedure for which this is an indication.
-
status
protected CodeableConcept status
General description.
-
description
protected MarkdownType description
General description.
-
contraindication
protected ClinicalUseIssue.ClinicalUseIssueContraindicationComponent contraindication
Specifics for when this is a contraindication.
-
indication
protected ClinicalUseIssue.ClinicalUseIssueIndicationComponent indication
Specifics for when this is an indication.
-
interaction
protected ClinicalUseIssue.ClinicalUseIssueInteractionComponent interaction
Specifics for when this is an interaction.
-
population
protected List<Population> population
The population group to which this applies.
-
undesirableEffect
protected ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent undesirableEffect
Describe the undesirable effects of the medicinal product.
-
SP_CONTRAINDICATION
public static final String SP_CONTRAINDICATION
Search parameter: contraindicationDescription: The situation that is being documented as contraindicating against this item
Type: token
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
- See Also:
- Constant Field Values
-
CONTRAINDICATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTRAINDICATION
Fluent Client search parameter constant for contraindicationDescription: The situation that is being documented as contraindicating against this item
Type: token
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
-
SP_EFFECT
public static final String SP_EFFECT
Search parameter: effectDescription: The situation in which the undesirable effect may manifest
Type: token
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
- See Also:
- Constant Field Values
-
EFFECT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EFFECT
Fluent Client search parameter constant for effectDescription: The situation in which the undesirable effect may manifest
Type: token
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for this issue
Type: token
Path: ClinicalUseIssue.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for this issue
Type: token
Path: ClinicalUseIssue.identifier
-
SP_INDICATION
public static final String SP_INDICATION
Search parameter: indicationDescription: The situation that is being documented as an indicaton for this item
Type: token
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
- See Also:
- Constant Field Values
-
INDICATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INDICATION
Fluent Client search parameter constant for indicationDescription: The situation that is being documented as an indicaton for this item
Type: token
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
-
SP_INTERACTION
public static final String SP_INTERACTION
Search parameter: interactionDescription: The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction
Type: token
Path: ClinicalUseIssue.interaction.type
- See Also:
- Constant Field Values
-
INTERACTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTERACTION
Fluent Client search parameter constant for interactionDescription: The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction
Type: token
Path: ClinicalUseIssue.interaction.type
-
SP_PRODUCT
public static final String SP_PRODUCT
Search parameter: productDescription: The medicinal product for which this is a clinical usage issue
Type: reference
Path: ClinicalUseIssue.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 productDescription: The medicinal product for which this is a clinical usage issue
Type: reference
Path: ClinicalUseIssue.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 "ClinicalUseIssue:product".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The resource for which this is a clinical usage issue
Type: reference
Path: ClinicalUseIssue.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: The resource for which this is a clinical usage issue
Type: reference
Path: ClinicalUseIssue.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 "ClinicalUseIssue:subject".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: indication | contraindication | interaction | undesirable-effect | other
Type: token
Path: ClinicalUseIssue.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: indication | contraindication | interaction | undesirable-effect | other
Type: token
Path: ClinicalUseIssue.type
-
-
Constructor Detail
-
ClinicalUseIssue
public ClinicalUseIssue()
Constructor
-
ClinicalUseIssue
public ClinicalUseIssue(ClinicalUseIssue.ClinicalUseIssueType type)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifier for this issue.)
-
setIdentifier
public ClinicalUseIssue setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ClinicalUseIssue 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<ClinicalUseIssue.ClinicalUseIssueType> getTypeElement()
- Returns:
type(indication | contraindication | interaction | undesirable-effect | other.). 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 ClinicalUseIssue setTypeElement(Enumeration<ClinicalUseIssue.ClinicalUseIssueType> value)
- Parameters:
value-type(indication | contraindication | interaction | undesirable-effect | other.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
public ClinicalUseIssue.ClinicalUseIssueType getType()
- Returns:
- indication | contraindication | interaction | undesirable-effect | other.
-
setType
public ClinicalUseIssue setType(ClinicalUseIssue.ClinicalUseIssueType value)
- Parameters:
value- indication | contraindication | interaction | undesirable-effect | other.
-
getSubject
public List<Reference> getSubject()
- Returns:
subject(The medication or procedure for which this is an indication.)
-
setSubject
public ClinicalUseIssue setSubject(List<Reference> theSubject)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubject
public boolean hasSubject()
-
addSubject
public Reference addSubject()
-
addSubject
public ClinicalUseIssue 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(General description.)
-
hasStatus
public boolean hasStatus()
-
setStatus
public ClinicalUseIssue setStatus(CodeableConcept value)
- Parameters:
value-status(General description.)
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(General description.). 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 ClinicalUseIssue setDescriptionElement(MarkdownType value)
- Parameters:
value-description(General description.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- General description.
-
setDescription
public ClinicalUseIssue setDescription(String value)
- Parameters:
value- General description.
-
getContraindication
public ClinicalUseIssue.ClinicalUseIssueContraindicationComponent getContraindication()
- Returns:
contraindication(Specifics for when this is a contraindication.)
-
hasContraindication
public boolean hasContraindication()
-
setContraindication
public ClinicalUseIssue setContraindication(ClinicalUseIssue.ClinicalUseIssueContraindicationComponent value)
- Parameters:
value-contraindication(Specifics for when this is a contraindication.)
-
getIndication
public ClinicalUseIssue.ClinicalUseIssueIndicationComponent getIndication()
- Returns:
indication(Specifics for when this is an indication.)
-
hasIndication
public boolean hasIndication()
-
setIndication
public ClinicalUseIssue setIndication(ClinicalUseIssue.ClinicalUseIssueIndicationComponent value)
- Parameters:
value-indication(Specifics for when this is an indication.)
-
getInteraction
public ClinicalUseIssue.ClinicalUseIssueInteractionComponent getInteraction()
- Returns:
interaction(Specifics for when this is an interaction.)
-
hasInteraction
public boolean hasInteraction()
-
setInteraction
public ClinicalUseIssue setInteraction(ClinicalUseIssue.ClinicalUseIssueInteractionComponent value)
- Parameters:
value-interaction(Specifics for when this is an interaction.)
-
getPopulation
public List<Population> getPopulation()
- Returns:
population(The population group to which this applies.)
-
setPopulation
public ClinicalUseIssue setPopulation(List<Population> thePopulation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPopulation
public boolean hasPopulation()
-
addPopulation
public Population addPopulation()
-
addPopulation
public ClinicalUseIssue addPopulation(Population t)
-
getPopulationFirstRep
public Population getPopulationFirstRep()
- Returns:
- The first repetition of repeating field
population, creating it if it does not already exist {3}
-
getUndesirableEffect
public ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent getUndesirableEffect()
- Returns:
undesirableEffect(Describe the undesirable effects of the medicinal product.)
-
hasUndesirableEffect
public boolean hasUndesirableEffect()
-
setUndesirableEffect
public ClinicalUseIssue setUndesirableEffect(ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent value)
- Parameters:
value-undesirableEffect(Describe the undesirable effects of the medicinal product.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ClinicalUseIssue copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ClinicalUseIssue dst)
-
typedCopy
protected ClinicalUseIssue typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-