
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<CodeableConcept>
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".Specifics for when this is a contraindication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contraindicationstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for contraindication-referenceprotected MarkdownType
General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for effectstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for effect-referenceprotected List<Identifier>
Business identifier for this issue.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.Specifics for when this is an indication.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for indicationstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for indication-referenceSpecifics for when this is an interaction.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for interactionprotected List<Population>
The population group to which this applies.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for productstatic final String
Search parameter: contraindicationstatic final String
Search parameter: contraindication-referencestatic final String
Search parameter: effectstatic final String
Search parameter: effect-referencestatic final String
Search parameter: identifierstatic final String
Search parameter: indicationstatic final String
Search parameter: indication-referencestatic final String
Search parameter: interactionstatic final String
Search parameter: productstatic final String
Search parameter: subjectstatic final String
Search parameter: typeprotected CodeableConcept
Whether this is a current issue or one that has been retired etc.The medication or procedure for which this is an indication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Enumeration<Enumerations.ClinicalUseIssueType>
indication | contraindication | interaction | undesirable-effect | warning.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeDescribe 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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCategory
(List<CodeableConcept> theCategory) setDescription
(String value) setIdentifier
(List<Identifier> theIdentifier) setPopulation
(List<Population> thePopulation) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStatus
(CodeableConcept value) setSubject
(List<Reference> theSubject) protected ClinicalUseIssue
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, copyUserData, 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, setId
-
Field Details
-
identifier
Business identifier for this issue. -
type
indication | contraindication | interaction | undesirable-effect | warning. -
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
The medication or procedure for which this is an indication. -
status
Whether this is a current issue or one that has been retired etc. -
description
General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example "May affect ability to drive". -
contraindication
Specifics for when this is a contraindication. -
indication
Specifics for when this is an indication. -
interaction
Specifics for when this is an interaction. -
population
The population group to which this applies. -
undesirableEffect
Describe the undesirable effects of the medicinal product. -
SP_CONTRAINDICATION_REFERENCE
Search parameter: contraindication-referenceDescription: The situation that is being documented as contraindicating against this item, as a reference
Type: reference
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
- See Also:
-
CONTRAINDICATION_REFERENCE
Fluent Client search parameter constant for contraindication-referenceDescription: The situation that is being documented as contraindicating against this item, as a reference
Type: reference
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
-
INCLUDE_CONTRAINDICATION_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseIssue:contraindication-reference". -
SP_CONTRAINDICATION
Search parameter: contraindicationDescription: The situation that is being documented as contraindicating against this item, as a code
Type: token
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
- See Also:
-
CONTRAINDICATION
Fluent Client search parameter constant for contraindicationDescription: The situation that is being documented as contraindicating against this item, as a code
Type: token
Path: ClinicalUseIssue.contraindication.diseaseSymptomProcedure
-
SP_EFFECT_REFERENCE
Search parameter: effect-referenceDescription: The situation in which the undesirable effect may manifest, as a reference
Type: reference
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
- See Also:
-
EFFECT_REFERENCE
Fluent Client search parameter constant for effect-referenceDescription: The situation in which the undesirable effect may manifest, as a reference
Type: reference
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
-
INCLUDE_EFFECT_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseIssue:effect-reference". -
SP_EFFECT
Search parameter: effectDescription: The situation in which the undesirable effect may manifest, as a code
Type: token
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
- See Also:
-
EFFECT
Fluent Client search parameter constant for effectDescription: The situation in which the undesirable effect may manifest, as a code
Type: token
Path: ClinicalUseIssue.undesirableEffect.symptomConditionEffect
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for this issue
Type: token
Path: ClinicalUseIssue.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for this issue
Type: token
Path: ClinicalUseIssue.identifier
-
SP_INDICATION_REFERENCE
Search parameter: indication-referenceDescription: The situation that is being documented as an indicaton for this item, as a reference
Type: reference
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
- See Also:
-
INDICATION_REFERENCE
Fluent Client search parameter constant for indication-referenceDescription: The situation that is being documented as an indicaton for this item, as a reference
Type: reference
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
-
INCLUDE_INDICATION_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseIssue:indication-reference". -
SP_INDICATION
Search parameter: indicationDescription: The situation that is being documented as an indicaton for this item, as a code
Type: token
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
- See Also:
-
INDICATION
Fluent Client search parameter constant for indicationDescription: The situation that is being documented as an indicaton for this item, as a code
Type: token
Path: ClinicalUseIssue.indication.diseaseSymptomProcedure
-
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:
-
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
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:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseIssue:product". -
SP_SUBJECT
Search parameter: subjectDescription: The resource for which this is a clinical usage issue
Type: reference
Path: ClinicalUseIssue.subject
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "ClinicalUseIssue:subject". -
SP_TYPE
Search parameter: typeDescription: indication | contraindication | interaction | undesirable-effect | warning
Type: token
Path: ClinicalUseIssue.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: indication | contraindication | interaction | undesirable-effect | warning
Type: token
Path: ClinicalUseIssue.type
-
-
Constructor Details
-
ClinicalUseIssue
public ClinicalUseIssue()Constructor -
ClinicalUseIssue
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for this issue.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
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
-
hasType
-
setTypeElement
- 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
- Returns:
- indication | contraindication | interaction | undesirable-effect | warning.
-
setType
- Parameters:
value
- indication | contraindication | interaction | undesirable-effect | warning.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
getSubject
- Returns:
subject
(The medication or procedure for which this is an indication.)
-
setSubject
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubject
-
addSubject
-
addSubject
-
getSubjectFirstRep
- Returns:
- The first repetition of repeating field
subject
, creating it if it does not already exist {3}
-
getStatus
- Returns:
status
(Whether this is a current issue or one that has been retired etc.)
-
hasStatus
-
setStatus
- Parameters:
value
-status
(Whether this is a current issue or one that has been retired etc.)
-
getDescriptionElement
- Returns:
description
(General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example "May affect ability to drive".). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example "May affect ability to drive".). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example "May affect ability to drive".
-
setDescription
- Parameters:
value
- General description of an effect (particularly for a general warning, rather than any of the more specific types such as indication) for when a distinct coded or textual description is not appropriate using Indication.diseaseSymptomProcedure.text, Contraindication.diseaseSymptomProcedure.text etc. For example "May affect ability to drive".
-
getContraindication
- Returns:
contraindication
(Specifics for when this is a contraindication.)
-
hasContraindication
-
setContraindication
public ClinicalUseIssue setContraindication(ClinicalUseIssue.ClinicalUseIssueContraindicationComponent value) - Parameters:
value
-contraindication
(Specifics for when this is a contraindication.)
-
getIndication
- Returns:
indication
(Specifics for when this is an indication.)
-
hasIndication
-
setIndication
- Parameters:
value
-indication
(Specifics for when this is an indication.)
-
getInteraction
- Returns:
interaction
(Specifics for when this is an interaction.)
-
hasInteraction
-
setInteraction
- Parameters:
value
-interaction
(Specifics for when this is an interaction.)
-
getPopulation
- Returns:
population
(The population group to which this applies.)
-
setPopulation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPopulation
-
addPopulation
-
addPopulation
-
getPopulationFirstRep
- Returns:
- The first repetition of repeating field
population
, creating it if it does not already exist {3}
-
getUndesirableEffect
- Returns:
undesirableEffect
(Describe the undesirable effects of the medicinal product.)
-
hasUndesirableEffect
-
setUndesirableEffect
public ClinicalUseIssue setUndesirableEffect(ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent value) - Parameters:
value
-undesirableEffect
(Describe the undesirable effects of the medicinal product.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-