AdverseEvent - FHIR Resource (r4)


This AdverseEvent Resource uses the FHIR API standard for access and structure.

Validate an AdverseEvent FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
actualityfalsecode# actual | potential
categorytrueCodeableConcept# 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
contributortrueReference# Who was involved in the adverse event or the potential adverse event
datefalsedateTime# When the event occurred
detectedfalsedateTime# When the event was detected
encounterfalseReference# Encounter created as part of
eventfalseCodeableConcept# Type of the event itself in relation to the subject
identifierfalseIdentifier# Business identifier for the event
locationfalseReference# Location where adverse event occurred
outcomefalseCodeableConcept# resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
recordedDatefalsedateTime# When the event was recorded
recorderfalseReference# "recorder" : { Reference(Patient|Practitioner|PractitionerRole|
referenceDocumenttrueReference# AdverseEvent.referenceDocument
resultingConditiontrueReference# Effect on the subject due to this event
seriousnessfalseCodeableConcept# Seriousness of the event
severityfalseCodeableConcept# mild | moderate | severe
studytrueReference# AdverseEvent.study
subjectfalseReference# Subject impacted by event
subjectMedicalHistorytrueReference# "subjectMedicalHistory" : [{ Reference(Condition|Observation|
suspectEntitytrueData Type# The suspected agent causing the adverse event

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 ParameterField TypeResource Fields Searched
actualitytextactuality
categorytextcategory
datedatedate
eventtextevent
locationreferencelocation
recorderreferencerecorder
resultingconditionreferenceresultingCondition
seriousnesstextseriousness
severitytextseverity
studyreferencestudy
subjectreferencesubject
substancereferencesuspectEntity.instance