AdverseEvent - FHIR Resource (stu3)
This AdverseEvent Resource uses the FHIR API standard for access and structure.
Validate an AdverseEvent FHIR Resource (stu3)
AdverseEvent Attributes
AttributeField is listTypeDescription
Description: AE | PAE
An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": "AE"Learn more about the (AdverseEvent) category FHIR attribute
Description: Adverse Reaction Events linked to exposure to substance
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reaction": Learn more about the (AdverseEvent) reaction FHIR attribute
Description: Business identifier for the event
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
}Learn more about the (AdverseEvent) identifier FHIR attribute
Description: AdverseEvent.referenceDocument
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"referenceDocument": Learn more about the (AdverseEvent) referenceDocument FHIR attribute
Description: AdverseEvent.study
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"study": Learn more about the (AdverseEvent) study FHIR attribute
Description: Who was involved in the adverse event or the potential adverse event
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"eventParticipant": Learn more about the (AdverseEvent) eventParticipant FHIR attribute
Description: Subject or group impacted by event
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (AdverseEvent) subject FHIR attribute
Description: "subjectMedicalHistory" : [{ Reference(Condition|Observation|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subjectMedicalHistory": Learn more about the (AdverseEvent) subjectMedicalHistory FHIR attribute
Description: Mild | Moderate | Severe
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"seriousness": {
"coding": [
{
"code": "Mild",
"system": "http://hl7.org/fhir/adverse-event-seriousness",
"display": "Mild"
}
]
}Learn more about the (AdverseEvent) seriousness FHIR attribute
Description: Location where adverse event occurred
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (AdverseEvent) location FHIR attribute
Description: The suspected agent causing the adverse event
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"suspectEntity": [
{
"instance": {
"reference": "Medication/example"
}
}
]Learn more about the (AdverseEvent) suspectEntity FHIR attribute
Description: When the event occurred
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2017-01-29T12:34:56+00:00"Learn more about the (AdverseEvent) date FHIR attribute
Description: Who recorded the adverse event
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recorder": {
"reference": "Practitioner/example"
}Learn more about the (AdverseEvent) recorder FHIR attribute
Description: resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcome": Learn more about the (AdverseEvent) outcome FHIR attribute
Description: actual | potential
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"coding": [
{
"code": "304386008",
"system": "http://snomed.info/sct",
"display": "O/E - itchy rash"
}
]
}Learn more about the (AdverseEvent) type FHIR attribute
Description: Description of the adverse event
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "This was a mild rash on the left forearm"Learn more about the (AdverseEvent) description FHIR attribute
AdverseEvent Example
{
"category": "AE",
"description": "This was a mild rash on the left forearm",
"resourceType": "AdverseEvent",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 49476534</p><p><b>category</b>: AE</p><p><b>type</b>: O/E - itchy rash <span>(Details : {SNOMED CT code '304386008' = 'O/E - itchy rash', given as 'O/E - itchy rash'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>date</b>: 29/01/2017 12:34:56 PM</p><p><b>seriousness</b>: Mild <span>(Details : {http://hl7.org/fhir/adverse-event-seriousness code 'Mild' = 'Mild', given as 'Mild'})</span></p><p><b>recorder</b>: <a>Practitioner/example</a></p><p><b>description</b>: This was a mild rash on the left forearm</p><h3>SuspectEntities</h3><table><tr><td>-</td><td><b>Instance</b></td></tr><tr><td>*</td><td><a>Medication/example</a></td></tr></table></div>"
},
"seriousness": {
"coding": [
{
"code": "Mild",
"system": "http://hl7.org/fhir/adverse-event-seriousness",
"display": "Mild"
}
]
},
"suspectEntity": [
{
"instance": {
"reference": "Medication/example"
}
}
],
"date": "2017-01-29T12:34:56+00:00",
"recorder": {
"reference": "Practitioner/example"
},
"identifier": {
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
},
"type": {
"coding": [
{
"code": "304386008",
"system": "http://snomed.info/sct",
"display": "O/E - itchy rash"
}
]
},
"id": "example",
"subject": {
"reference": "Patient/example"
}
}AdverseEvent Structure
{
"resourceType" : "AdverseEvent",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Business identifier for the event
"category" : "<code>", // AE | PAE
An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not
"type" : { CodeableConcept }, // actual | potential
"subject" : { Reference(Patient|ResearchSubject|Medication|Device) }, // Subject or group impacted by event
"date" : "<dateTime>", // When the event occurred
"reaction" : [{ Reference(Condition) }], // Adverse Reaction Events linked to exposure to substance
"location" : { Reference(Location) }, // Location where adverse event occurred
"seriousness" : { CodeableConcept }, // Mild | Moderate | Severe
"outcome" : { CodeableConcept }, // resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
"recorder" : { Reference(Patient|Practitioner|RelatedPerson) }, // Who recorded the adverse event
"eventParticipant" : { Reference(Practitioner|Device) }, // Who was involved in the adverse event or the potential adverse event
"description" : "<string>", // Description of the adverse event
"suspectEntity" : [{ // The suspected agent causing the adverse event
"instance" : { Reference(Substance|Medication|MedicationAdministration|
MedicationStatement|Device) }, // R! Refers to the specific entity that caused the adverse event
"causality" : "<code>", // causality1 | causality2
"causalityAssessment" : { CodeableConcept }, // assess1 | assess2
"causalityProductRelatedness" : "<string>", // AdverseEvent.suspectEntity.causalityProductRelatedness
"causalityMethod" : { CodeableConcept }, // method1 | method2
"causalityAuthor" : { Reference(Practitioner|PractitionerRole) }, // AdverseEvent.suspectEntity.causalityAuthor
"causalityResult" : { CodeableConcept } // result1 | result2
}],
"subjectMedicalHistory" : [{ Reference(Condition|Observation|
AllergyIntolerance|FamilyMemberHistory|Immunization|Procedure) }], // AdverseEvent.subjectMedicalHistory
"referenceDocument" : [{ Reference(DocumentReference) }], // AdverseEvent.referenceDocument
"study" : [{ Reference(ResearchStudy) }] // AdverseEvent.study
}
AdverseEvent Search Parameters
The following search parameters can be used to query AdverseEvent resources. Just submit them like so:
https://api.1up.health/fhir/stu3/AdverseEvent?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
category | text | category |
date | date | date |
location | reference | location |
reaction | reference | reaction |
recorder | reference | recorder |
seriousness | text | seriousness |
study | reference | study |
subject | reference | subject |
substance | reference | suspectEntity.instance |
type | text | type |
