Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.AdverseEvent

class HS.FHIR.DTL.vR4.Model.Resource.AdverseEvent extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Medical care, research study or other healthcare event causing physical injury.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = AdverseEvent;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = AdverseEvent;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property actuality as %String (MAXLEN = 1000000, XMLNAME = "actuality", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

actual | potential

adverse-event-actuality|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend adverse-event-actuality|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: actualityDisplayToLogical(), actualityGet(), actualityIsValid(), actualityLogicalToDisplay(), actualityLogicalToOdbc(), actualityNormalize(), actualitySet()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
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

adverse-event-category is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in adverse-event-category, you may formally EXTEND adverse-event-category to add codes to it.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property contributor as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "contributor", XMLPROJECTION = "ELEMENT");
Reference

Who was involved in the adverse event or the potential adverse event.

Practitioner | PractitionerRole | Device

Property methods: contributorBuildValueArray(), contributorCollectionToDisplay(), contributorCollectionToOdbc(), contributorDisplayToCollection(), contributorGet(), contributorGetObject(), contributorGetObjectId(), contributorGetSwizzled(), contributorIsValid(), contributorOdbcToCollection(), contributorSet(), contributorSetObject(), contributorSetObjectId()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the event occurred.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property detected as %String (MAXLEN = 1000000, XMLNAME = "detected", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the event was detected.

Property methods: detectedDisplayToLogical(), detectedGet(), detectedIsValid(), detectedLogicalToDisplay(), detectedLogicalToOdbc(), detectedNormalize(), detectedSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter created as part of.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property event as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "event", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of the event itself in relation to the subject.

any FHIR4 code may be used; adverse-event-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: eventGet(), eventGetSwizzled(), eventIsValid(), eventNewObject(), eventSet()
property identifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier for the event.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Location where adverse event occurred.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property outcome as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
CodeableConcept

resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown

adverse-event-outcome|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend adverse-event-outcome|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property recordedDate as %String (MAXLEN = 1000000, XMLNAME = "recordedDate", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the event was recorded.

Property methods: recordedDateDisplayToLogical(), recordedDateGet(), recordedDateIsValid(), recordedDateLogicalToDisplay(), recordedDateLogicalToOdbc(), recordedDateNormalize(), recordedDateSet()
property recorder as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "recorder", XMLPROJECTION = "ELEMENT");
Reference

Who recorded the adverse event.

Patient | Practitioner | PractitionerRole | RelatedPerson

Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property referenceDocument as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referenceDocument", XMLPROJECTION = "ELEMENT");
Reference

AdverseEvent.referenceDocument.

DocumentReference

Property methods: referenceDocumentBuildValueArray(), referenceDocumentCollectionToDisplay(), referenceDocumentCollectionToOdbc(), referenceDocumentDisplayToCollection(), referenceDocumentGet(), referenceDocumentGetObject(), referenceDocumentGetObjectId(), referenceDocumentGetSwizzled(), referenceDocumentIsValid(), referenceDocumentOdbcToCollection(), referenceDocumentSet(), referenceDocumentSetObject(), referenceDocumentSetObjectId()
property resultingCondition as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "resultingCondition", XMLPROJECTION = "ELEMENT");
Reference

Effect on the subject due to this event.

Condition

Property methods: resultingConditionBuildValueArray(), resultingConditionCollectionToDisplay(), resultingConditionCollectionToOdbc(), resultingConditionDisplayToCollection(), resultingConditionGet(), resultingConditionGetObject(), resultingConditionGetObjectId(), resultingConditionGetSwizzled(), resultingConditionIsValid(), resultingConditionOdbcToCollection(), resultingConditionSet(), resultingConditionSetObject(), resultingConditionSetObjectId()
property seriousness as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "seriousness", XMLPROJECTION = "ELEMENT");
CodeableConcept

Seriousness of the event.

any FHIR4 code may be used; adverse-event-seriousness shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: seriousnessGet(), seriousnessGetSwizzled(), seriousnessIsValid(), seriousnessNewObject(), seriousnessSet()
property severity as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "severity", XMLPROJECTION = "ELEMENT");
CodeableConcept

mild | moderate | severe

adverse-event-severity|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend adverse-event-severity|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: severityGet(), severityGetSwizzled(), severityIsValid(), severityNewObject(), severitySet()
property study as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "study", XMLPROJECTION = "ELEMENT");
Reference

AdverseEvent.study.

ResearchStudy

Property methods: studyBuildValueArray(), studyCollectionToDisplay(), studyCollectionToOdbc(), studyDisplayToCollection(), studyGet(), studyGetObject(), studyGetObjectId(), studyGetSwizzled(), studyIsValid(), studyOdbcToCollection(), studySet(), studySetObject(), studySetObjectId()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Subject impacted by event.

Patient | Group | Practitioner | RelatedPerson

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectMedicalHistoryBuildValueArray(), subjectMedicalHistoryCollectionToDisplay(), subjectMedicalHistoryCollectionToOdbc(), subjectMedicalHistoryDisplayToCollection(), subjectMedicalHistoryGet(), subjectMedicalHistoryGetObject(), subjectMedicalHistoryGetObjectId(), subjectMedicalHistoryGetSwizzled(), subjectMedicalHistoryIsValid(), subjectMedicalHistoryOdbcToCollection(), subjectMedicalHistorySet(), subjectMedicalHistorySetObject(), subjectMedicalHistorySetObjectId(), subjectNewObject(), subjectSet()
property subjectMedicalHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subjectMedicalHistory", XMLPROJECTION = "ELEMENT");
Reference

AdverseEvent.subjectMedicalHistory.

Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference

Property methods: subjectMedicalHistoryBuildValueArray(), subjectMedicalHistoryCollectionToDisplay(), subjectMedicalHistoryCollectionToOdbc(), subjectMedicalHistoryDisplayToCollection(), subjectMedicalHistoryGet(), subjectMedicalHistoryGetObject(), subjectMedicalHistoryGetObjectId(), subjectMedicalHistoryGetSwizzled(), subjectMedicalHistoryIsValid(), subjectMedicalHistoryOdbcToCollection(), subjectMedicalHistorySet(), subjectMedicalHistorySetObject(), subjectMedicalHistorySetObjectId()
property suspectEntity as list of HS.FHIR.DTL.vR4.Model.Element.AdverseEvent.suspectEntity (XMLNAME = "suspectEntity", XMLPROJECTION = "ELEMENT");
BackboneElement

The suspected agent causing the adverse event.

Property methods: suspectEntityBuildValueArray(), suspectEntityCollectionToDisplay(), suspectEntityCollectionToOdbc(), suspectEntityDisplayToCollection(), suspectEntityGet(), suspectEntityGetObject(), suspectEntityGetObjectId(), suspectEntityGetSwizzled(), suspectEntityIsValid(), suspectEntityOdbcToCollection(), suspectEntitySet(), suspectEntitySetObject(), suspectEntitySetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab