| AdverseEventReporting UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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. |
«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. |
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. |
«CS» Code | countryWhereObtained |
"The country where the medicinal was obtained." - ICH E2B(R3), G.k.2.4 |
«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. |
«TS» PointInTime | dateReturnedToMfr |
If the product was returned to manufacturer, this property will contain the date it was returned. |
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 |
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 |
"The gestational age at the time of the earliest exposure." - ICH E2B(R3), G.k.6a and G.k.6b. |
«CS» Code | indication |
Identifies what the medication was intended to treat (i.e., diagnosis). |
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. |
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. |
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 |
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 |
"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 |
"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 Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ProductRole |
Name Expression | |
Namespace | AdverseEventReporting |
Owned Template Signature | |
Owner | AdverseEventReporting |
Owning Template Parameter | |
Package | AdverseEventReporting |
Qualified Name | FHIM::AdverseEventReporting::ProductRole |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | actionTaken |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::actionTaken |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | additionalInformationCoded |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::additionalInformationCoded |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | additionalInformationText |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::additionalInformationText |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0 |
Name | countryWhereObtained |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::countryWhereObtained |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 0 |
Upper Value | (0) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | cumulativeDose |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::cumulativeDose |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dateReturnedToMfr |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::dateReturnedToMfr |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public DeviceObservation deviceObservation
Pointer to any medical devices (whether suspect or concommittant) used by the subject near the time of the adverse event occurred.
Aggregation | None |
Alias | |
Association | (deviceObservation:DeviceObservation) |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | deviceObservation |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::deviceObservation |
Stereotype | |
Template Parameter | |
Type | DeviceObservation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | (drugObservation:DrugObservation) |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | drugObservation |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::drugObservation |
Stereotype | |
Template Parameter | |
Type | DrugObservation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» TimeQuantity gestationalAgeAtExposure
"The gestational age at the time of the earliest exposure." - ICH E2B(R3), G.k.6a and G.k.6b.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | gestationalAgeAtExposure |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::gestationalAgeAtExposure |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | indication |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::indication |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | indicationText |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::indicationText |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isAvailableForEvaluation |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::isAvailableForEvaluation |
Stereotype | |
Template Parameter | |
Type | ProductAvailabiltiy |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | isBlinded |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::isBlinded |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | (productEventRelationship:ProductEventRelationship) |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | productEventRelationship |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::productEventRelationship |
Stereotype | |
Template Parameter | |
Type | ProductEventRelationship |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | productNameReported |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::productNameReported |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ProductRole |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | productRole |
Name Expression | |
Namespace | ProductRole |
Opposite | |
Owner | ProductRole |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::AdverseEventReporting::ProductRole::productRole |
Stereotype | |
Template Parameter | |
Type | ProductRole |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| AdverseEventReporting UML Documentation |
Summary:AttributesProperties | Detail:Attributes |