AdverseEventReporting
Class ProductRole

This class provides information on the medical product(s) (i.e., medical device or drug) that is either suspected to have caused an adverse event, or that was in use at the time of the adverse event and which may or may not have contributed to the event. Note that this class is used to navigate from the Case Safety Report to observations about the drug or device, which in turn point to the drug and device classes.
"The characterisation of the drug role as provided by the primary reporter or, if this information is missing, by the sender. All spontaneous reports should have at least one suspect drug...." - ICH E2B(R3), G.k.1.

Attributes
«CS» Code actionTaken actionTaken

If the product in question is a drug, this property describes what changes were made to the drug administration as a result of the adverse event. This property is not used when the product is a device.
"The action taken with the drug as a result of the reaction(s) / event(s). The value Drug withdrawn, taken together with the Outcome of Reaction /Event at the Time of Last Observation (E.i.7), describe the dechallenge. Not applicable should be used in circumstances such as when the patient has died or the treatment had been completed prior to reaction(s) /event(s) or the Characterisation of Drug Role (G.k.1) is Drug Not Administered. When Not applicable is used, details should be captured in Section H." - ICH E2B(R3), G.k.8. Possible values include: Drug withdrawn; Dose reduced; Dose increased; Dose not changed; Unknown; Not applicable.

«CS» Code additionalInformationCoded additionalInformationCoded

"Any additional information pertinent to the case that is not covered by the sections above." - ICH E2B(R3), G.k.10.r. Possible values include: Counterfeit; Overdose; Drug taken by the father; Drug taken beyond expiry date; Batch and lot tested and found within specifications; Batch and lot tested and found not within specifications; Medication error; Misuse; Abuse; Occupational exposure; Off label use.

String additionalInformationText additionalInformationText

"Any additional drug information in free text format not described in G.k.10.r. For example, expiry date for the lot number described in G.k.4.r.7 would be captured in this data element." - ICH E2B(R3), G.k.11.

«CS» Code countryWhereObtained countryWhereObtained

"The country where the medicinal was obtained." - ICH E2B(R3), G.k.2.4
Note that this property is included for compatibility to the ICH and the ICSR, but does not appear to be currently needed by U.S. Federal agencies, therefore, the cardinality of this property has been set to zero.

«PQ» Quantity cumulativeDose cumulativeDose

"The cumulative dose administered until the onset of the first sign, symptom or reaction/event." - ICH E2B(R3), G.k.5a and G.k.5b.

«TS» PointInTime dateReturnedToMfr dateReturnedToMfr

If the product was returned to manufacturer, this property will contain the date it was returned.
MedWatch 3500 form question C.1.
MedWatch 3500A form question D.10.
(note that the MedWatch 3500B and the VAERS-1 forms do not have this element).

DeviceObservation deviceObservation deviceObservation

Pointer to any medical devices (whether suspect or concommittant) used by the subject near the time of the adverse event occurred.

DrugObservation drugObservation drugObservation

Pointer to any medicinal products (whether suspect or concommittant) given to or taken by the subject near the time of the adverse event occurred.

«PQ» TimeQuantity gestationalAgeAtExposure gestationalAgeAtExposure

"The gestational age at the time of the earliest exposure." - ICH E2B(R3), G.k.6a and G.k.6b.

«CS» Code indication indication

Identifies what the medication was intended to treat (i.e., diagnosis).

"The indication of the medicinal product." - ICH E2B(R3), G.k.7.r.2a and G.k.7.r.2b.

Medwatch 3500 form question D.4; Medwatch 3500A form question C.4; Medwatch 3500B form question B.12.

String indicationText indicationText

"The original reporter's words and / or short phrases used to describe the indication for drug use in an English translation for international transmission." - ICH E2B(R3), G.k.7.r.1.

ProductAvailabiltiy isAvailableForEvaluation isAvailableForEvaluation

Is the product available for evaluation by the FDA? Possible answers are: Yes; No; Returned to manufacturer. If Returned to Manufacturer is selected, the date returned to manufacturer should be valued.
MedWatch 3500 form question C.1.
MedWatch 3500A form question D.10.
MedWatch 3500B form question B.15 (note that the 3500B only has yes or no).
(note that the VAERS-1 form does not have this element).

Boolean isBlinded isBlinded

"This data element is applicable only to ICSRs from clinical trials. The ICH E2A guideline recommends that the case safety reports with blinded therapy should not be reported. However, if it is important to exchange a blinded case safety report during a clinical trial, this data element should be used as follows: until the investigational product is un-blinded, the status Blinded should be indicated by using True in this data element. When this data element is True, Section G.k.2 Drug Identification should be populated with the characteristics of the investigational product. When more than one investigational product is potentially suspect, each suspect product should be represented in separate G.k blocks. After un-blinding, if appropriate, Placebo should be reported in G.k.2.3.r as a suspect drug." - ICH E2B(R3), G.k.2.5

ProductEventRelationship productEventRelationship productEventRelationship

Pointer to a structures that link a reaction or adverse event with the various medical products (medical devices and/or drugs) that were being used by the patient, and provides an assessment of whether the reaction / adverse event may have been caused by or exacerbated by the product.

String productNameReported productNameReported

"The name of the medicinal product as used by the reporter. It is recognized that a single product can have different proprietary names in different countries, even when it is produced by a single manufacturer." - ICH E2B(R3), G.k.2.2.

ProductRole productRole productRole

"The characterisation of the drug role as provided by the primary reporter or, if this information is missing, by the sender. All spontaneous reports should have at least one suspect drug.... If the reporter indicates a suspected interaction with other drug(s), Interacting should be selected for all suspected interacting drug(s). If an interaction is suspected with food or other non-drug compounds, Interacting should be selected for the suspect drug. For evaluation purposes, all interacting drugs are considered to be suspect drugs.... Drug not administered can be used in two circumstances: In clinical trial: if the adverse event occurred after the informed consent was signed but prior to the administration of the study drug (e.g. during the screening period or the washout procedure), the adverse event should in general be reported as per the trial procedure.... Medication error: if the patient did not receive the actual prescribed drug but another one, repeatable Sections G should be completed with the information about the prescribed drug (including the fact that it was not administered), as well as the information on the dispensed drug as the Suspect drug...." - ICH E2B(R3), G.k.1. Possible values include: Suspect; Concomitant; Interacting; Drug Not Administered.


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameProductRole
Name Expression
NamespaceAdverseEventReporting
Owned Template Signature
OwnerAdverseEventReporting
Owning Template Parameter
PackageAdverseEventReporting
Qualified NameFHIM::AdverseEventReporting::ProductRole
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 actionTaken
Public «CS» Code actionTaken

If the product in question is a drug, this property describes what changes were made to the drug administration as a result of the adverse event. This property is not used when the product is a device.
"The action taken with the drug as a result of the reaction(s) / event(s). The value Drug withdrawn, taken together with the Outcome of Reaction /Event at the Time of Last Observation (E.i.7), describe the dechallenge. Not applicable should be used in circumstances such as when the patient has died or the treatment had been completed prior to reaction(s) /event(s) or the Characterisation of Drug Role (G.k.1) is Drug Not Administered. When Not applicable is used, details should be captured in Section H." - ICH E2B(R3), G.k.8. Possible values include: Drug withdrawn; Dose reduced; Dose increased; Dose not changed; Unknown; Not applicable.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameactionTaken
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::actionTaken
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 additionalInformationCoded
Public «CS» Code additionalInformationCoded

"Any additional information pertinent to the case that is not covered by the sections above." - ICH E2B(R3), G.k.10.r. Possible values include: Counterfeit; Overdose; Drug taken by the father; Drug taken beyond expiry date; Batch and lot tested and found within specifications; Batch and lot tested and found not within specifications; Medication error; Misuse; Abuse; Occupational exposure; Off label use.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameadditionalInformationCoded
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::additionalInformationCoded
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 additionalInformationText
Public String additionalInformationText

"Any additional drug information in free text format not described in G.k.10.r. For example, expiry date for the lot number described in G.k.4.r.7 would be captured in this data element." - ICH E2B(R3), G.k.11.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameadditionalInformationText
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::additionalInformationText
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 countryWhereObtained
Public «CS» Code countryWhereObtained

"The country where the medicinal was obtained." - ICH E2B(R3), G.k.2.4
Note that this property is included for compatibility to the ICH and the ICSR, but does not appear to be currently needed by U.S. Federal agencies, therefore, the cardinality of this property has been set to zero.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0
NamecountryWhereObtained
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::countryWhereObtained
Stereotype
Template Parameter
Type«CS» Code
Upper0
Upper Value(0)
VisibilityPublic


 cumulativeDose
Public «PQ» Quantity cumulativeDose

"The cumulative dose administered until the onset of the first sign, symptom or reaction/event." - ICH E2B(R3), G.k.5a and G.k.5b.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecumulativeDose
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::cumulativeDose
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 dateReturnedToMfr
Public «TS» PointInTime dateReturnedToMfr

If the product was returned to manufacturer, this property will contain the date it was returned.
MedWatch 3500 form question C.1.
MedWatch 3500A form question D.10.
(note that the MedWatch 3500B and the VAERS-1 forms do not have this element).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateReturnedToMfr
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::dateReturnedToMfr
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 deviceObservation
Public DeviceObservation deviceObservation

Pointer to any medical devices (whether suspect or concommittant) used by the subject near the time of the adverse event occurred.

Constraints:
Properties:

AggregationNone
Alias
Association(deviceObservation:DeviceObservation)
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedeviceObservation
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::deviceObservation
Stereotype
Template Parameter
TypeDeviceObservation
Upper1
Upper Value(1)
VisibilityPublic


 drugObservation
Public DrugObservation drugObservation

Pointer to any medicinal products (whether suspect or concommittant) given to or taken by the subject near the time of the adverse event occurred.

Constraints:
Properties:

AggregationNone
Alias
Association(drugObservation:DrugObservation)
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedrugObservation
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::drugObservation
Stereotype
Template Parameter
TypeDrugObservation
Upper1
Upper Value(1)
VisibilityPublic


 gestationalAgeAtExposure
Public «PQ» TimeQuantity gestationalAgeAtExposure

"The gestational age at the time of the earliest exposure." - ICH E2B(R3), G.k.6a and G.k.6b.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamegestationalAgeAtExposure
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::gestationalAgeAtExposure
Stereotype
Template Parameter
Type«PQ» TimeQuantity
Upper1
Upper Value(1)
VisibilityPublic


 indication
Public «CS» Code indication

Identifies what the medication was intended to treat (i.e., diagnosis).

"The indication of the medicinal product." - ICH E2B(R3), G.k.7.r.2a and G.k.7.r.2b.

Medwatch 3500 form question D.4; Medwatch 3500A form question C.4; Medwatch 3500B form question B.12.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameindication
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::indication
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 indicationText
Public String indicationText

"The original reporter's words and / or short phrases used to describe the indication for drug use in an English translation for international transmission." - ICH E2B(R3), G.k.7.r.1.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameindicationText
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::indicationText
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 isAvailableForEvaluation
Public ProductAvailabiltiy isAvailableForEvaluation

Is the product available for evaluation by the FDA? Possible answers are: Yes; No; Returned to manufacturer. If Returned to Manufacturer is selected, the date returned to manufacturer should be valued.
MedWatch 3500 form question C.1.
MedWatch 3500A form question D.10.
MedWatch 3500B form question B.15 (note that the 3500B only has yes or no).
(note that the VAERS-1 form does not have this element).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisAvailableForEvaluation
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::isAvailableForEvaluation
Stereotype
Template Parameter
TypeProductAvailabiltiy
Upper1
Upper Value(1)
VisibilityPublic


 isBlinded
Public Boolean isBlinded

"This data element is applicable only to ICSRs from clinical trials. The ICH E2A guideline recommends that the case safety reports with blinded therapy should not be reported. However, if it is important to exchange a blinded case safety report during a clinical trial, this data element should be used as follows: until the investigational product is un-blinded, the status Blinded should be indicated by using True in this data element. When this data element is True, Section G.k.2 Drug Identification should be populated with the characteristics of the investigational product. When more than one investigational product is potentially suspect, each suspect product should be represented in separate G.k blocks. After un-blinding, if appropriate, Placebo should be reported in G.k.2.3.r as a suspect drug." - ICH E2B(R3), G.k.2.5

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisBlinded
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::isBlinded
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 productEventRelationship
Public ProductEventRelationship productEventRelationship

Pointer to a structures that link a reaction or adverse event with the various medical products (medical devices and/or drugs) that were being used by the patient, and provides an assessment of whether the reaction / adverse event may have been caused by or exacerbated by the product.

Constraints:
Properties:

AggregationNone
Alias
Association(productEventRelationship:ProductEventRelationship)
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameproductEventRelationship
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::productEventRelationship
Stereotype
Template Parameter
TypeProductEventRelationship
Upper*
Upper Value(*)
VisibilityPublic


 productNameReported
Public String productNameReported

"The name of the medicinal product as used by the reporter. It is recognized that a single product can have different proprietary names in different countries, even when it is produced by a single manufacturer." - ICH E2B(R3), G.k.2.2.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameproductNameReported
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::productNameReported
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 productRole
Public ProductRole productRole

"The characterisation of the drug role as provided by the primary reporter or, if this information is missing, by the sender. All spontaneous reports should have at least one suspect drug.... If the reporter indicates a suspected interaction with other drug(s), Interacting should be selected for all suspected interacting drug(s). If an interaction is suspected with food or other non-drug compounds, Interacting should be selected for the suspect drug. For evaluation purposes, all interacting drugs are considered to be suspect drugs.... Drug not administered can be used in two circumstances: In clinical trial: if the adverse event occurred after the informed consent was signed but prior to the administration of the study drug (e.g. during the screening period or the washout procedure), the adverse event should in general be reported as per the trial procedure.... Medication error: if the patient did not receive the actual prescribed drug but another one, repeatable Sections G should be completed with the information about the prescribed drug (including the fact that it was not administered), as well as the information on the dispensed drug as the Suspect drug...." - ICH E2B(R3), G.k.1. Possible values include: Suspect; Concomitant; Interacting; Drug Not Administered.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProductRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameproductRole
Name Expression
NamespaceProductRole
Opposite
OwnerProductRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::AdverseEventReporting::ProductRole::productRole
Stereotype
Template Parameter
TypeProductRole
Upper1
Upper Value(1)
VisibilityPublic