AdverseEvent - FHIR Resource (r4)
This AdverseEvent Resource uses the FHIR API standard for access and structure.
Validate an AdverseEvent FHIR Resource (r4)
AdverseEvent Attributes
AttributeField is listTypeDescription
Description: Business identifier for the event
FHIR Version: r4
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: actual | potential
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actuality": "actual"Learn more about the (AdverseEvent) actuality FHIR attribute
Description: product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-category",
"code": "product-use-error",
"display": "Product Use Error"
}
]
}
]Learn more about the (AdverseEvent) category FHIR attribute
Description: Type of the event itself in relation to the subject
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"event": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304386008",
"display": "O/E - itchy rash"
}
],
"text": "This was a mild rash on the left forearm"
}Learn more about the (AdverseEvent) event FHIR attribute
Description: Subject impacted by event
FHIR Version: r4
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: Encounter created as part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (AdverseEvent) encounter FHIR attribute
Description: When the event occurred
FHIR Version: r4
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: When the event was detected
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"detected": Learn more about the (AdverseEvent) detected FHIR attribute
Description: When the event was recorded
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recordedDate": Learn more about the (AdverseEvent) recordedDate FHIR attribute
Description: Effect on the subject due to this event
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"resultingCondition": Learn more about the (AdverseEvent) resultingCondition FHIR attribute
Description: Location where adverse event occurred
FHIR Version: r4
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: Seriousness of the event
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"seriousness": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-seriousness",
"code": "Non-serious",
"display": "Non-serious"
}
]
}Learn more about the (AdverseEvent) seriousness FHIR attribute
Description: mild | moderate | severe
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"severity": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-severity",
"code": "mild",
"display": "Mild"
}
]
}Learn more about the (AdverseEvent) severity FHIR attribute
Description: resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
FHIR Version: r4
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: "recorder" : { Reference(Patient|Practitioner|PractitionerRole|
FHIR Version: r4
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: Who was involved in the adverse event or the potential adverse event
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contributor": Learn more about the (AdverseEvent) contributor FHIR attribute
Description: The suspected agent causing the adverse event
FHIR Version: r4
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: "subjectMedicalHistory" : [{ Reference(Condition|Observation|
FHIR Version: r4
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: AdverseEvent.referenceDocument
FHIR Version: r4
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: r4
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
AdverseEvent Example
{
"resourceType": "AdverseEvent",
"id": "example",
"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>actuality</b>: actual</p><p><b>category</b>: Product Use Error <span>(Details : {http://terminology.hl7.org/CodeSystem/adverse-event-category code 'product-use-error' = 'Product Use Error', given as 'Product Use Error'})</span></p><p><b>event</b>: This was a mild rash on the left forearm <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>: Non-serious <span>(Details : {http://terminology.hl7.org/CodeSystem/adverse-event-seriousness code 'Non-serious' = 'Non-serious', given as 'Non-serious'})</span></p><p><b>severity</b>: Mild <span>(Details : {http://terminology.hl7.org/CodeSystem/adverse-event-severity code 'mild' = 'Mild', given as 'Mild'})</span></p><p><b>recorder</b>: <a>Practitioner/example</a></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>"
},
"identifier": {
"system": "http://acme.com/ids/patients/risks",
"value": "49476534"
},
"actuality": "actual",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-category",
"code": "product-use-error",
"display": "Product Use Error"
}
]
}
],
"event": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304386008",
"display": "O/E - itchy rash"
}
],
"text": "This was a mild rash on the left forearm"
},
"subject": {
"reference": "Patient/example"
},
"date": "2017-01-29T12:34:56+00:00",
"seriousness": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-seriousness",
"code": "Non-serious",
"display": "Non-serious"
}
]
},
"severity": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/adverse-event-severity",
"code": "mild",
"display": "Mild"
}
]
},
"recorder": {
"reference": "Practitioner/example"
},
"suspectEntity": [
{
"instance": {
"reference": "Medication/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
"actuality" : "<code>", // R! actual | potential
"category" : [{ CodeableConcept }], // product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment
"event" : { CodeableConcept }, // Type of the event itself in relation to the subject
"subject" : { Reference(Patient|Group|Practitioner|RelatedPerson) }, // R! Subject impacted by event
"encounter" : { Reference(Encounter) }, // Encounter created as part of
"date" : "<dateTime>", // When the event occurred
"detected" : "<dateTime>", // When the event was detected
"recordedDate" : "<dateTime>", // When the event was recorded
"resultingCondition" : [{ Reference(Condition) }], // Effect on the subject due to this event
"location" : { Reference(Location) }, // Location where adverse event occurred
"seriousness" : { CodeableConcept }, // Seriousness of the event
"severity" : { CodeableConcept }, // mild | moderate | severe
"outcome" : { CodeableConcept }, // resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
"recorder" : { Reference(Patient|Practitioner|PractitionerRole|
RelatedPerson) }, // Who recorded the adverse event
"contributor" : [{ Reference(Practitioner|PractitionerRole|Device) }], // Who was involved in the adverse event or the potential adverse event
"suspectEntity" : [{ // The suspected agent causing the adverse event
"instance" : { Reference(Immunization|Procedure|Substance|Medication|
MedicationAdministration|MedicationStatement|Device) }, // R! Refers to the specific entity that caused the adverse event
"causality" : [{ // Information on the possible cause of the event
"assessment" : { CodeableConcept }, // Assessment of if the entity caused the event
"productRelatedness" : "<string>", // AdverseEvent.suspectEntity.causalityProductRelatedness
"author" : { Reference(Practitioner|PractitionerRole) }, // AdverseEvent.suspectEntity.causalityAuthor
"method" : { CodeableConcept } // ProbabilityScale | Bayesian | Checklist
}]
}],
"subjectMedicalHistory" : [{ Reference(Condition|Observation|
AllergyIntolerance|FamilyMemberHistory|Immunization|Procedure|Media|
DocumentReference) }], // 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/r4/AdverseEvent?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
actuality | text | actuality |
category | text | category |
date | date | date |
event | text | event |
location | reference | location |
recorder | reference | recorder |
resultingcondition | reference | resultingCondition |
seriousness | text | seriousness |
severity | text | severity |
study | reference | study |
subject | reference | subject |
substance | reference | suspectEntity.instance |
