Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (16)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.AdverseEvent

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

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

Property Inventory

category
date
description
eventParticipant
identifier
location
outcome
reaction
recorder
referenceDocument
seriousness
study
subject
subjectMedicalHistory
suspectEntity
type

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 category as %String (MAXLEN = 1000000, XMLNAME = "category", XMLPROJECTION = "ATTRIBUTE");

code

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.

adverse-event-category is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend adverse-event-category and you may NOT use codes from other ValueSets.

Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()

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 description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

string

Description of the adverse event.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()

property eventParticipant as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "eventParticipant", XMLPROJECTION = "ELEMENT");

Reference

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

Practitioner | Device

Property methods: eventParticipantGet(), eventParticipantGetSwizzled(), eventParticipantIsValid(), eventParticipantNewObject(), eventParticipantSet()

property identifier as HS.FHIR.DTL.vSTU3.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.vSTU3.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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");

CodeableConcept

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

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()

property reaction as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reaction", XMLPROJECTION = "ELEMENT");

Reference

Adverse Reaction Events linked to exposure to substance.

Condition

Property methods: reactionBuildValueArray(), reactionCollectionToDisplay(), reactionCollectionToOdbc(), reactionDisplayToCollection(), reactionGet(), reactionGetObject(), reactionGetObjectId(), reactionGetSwizzled(), reactionIsValid(), reactionOdbcToCollection(), reactionSet(), reactionSetObject(), reactionSetObjectId()

property recorder as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "recorder", XMLPROJECTION = "ELEMENT");

Reference

Who recorded the adverse event.

Patient | Practitioner | RelatedPerson

Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()

property referenceDocument as list of HS.FHIR.DTL.vSTU3.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 seriousness as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "seriousness", XMLPROJECTION = "ELEMENT");

CodeableConcept

Mild | Moderate | Severe

any FHIR3 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 study as list of HS.FHIR.DTL.vSTU3.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.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Reference

Subject or group impacted by event.

Patient | ResearchSubject | Medication | Device

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

property subjectMedicalHistory as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subjectMedicalHistory", XMLPROJECTION = "ELEMENT");

Reference

AdverseEvent:subjectMedicalHistory.

Property methods: subjectMedicalHistoryBuildValueArray(), subjectMedicalHistoryCollectionToDisplay(), subjectMedicalHistoryCollectionToOdbc(), subjectMedicalHistoryDisplayToCollection(), subjectMedicalHistoryGet(), subjectMedicalHistoryGetObject(), subjectMedicalHistoryGetObjectId(), subjectMedicalHistoryGetSwizzled(), subjectMedicalHistoryIsValid(), subjectMedicalHistoryOdbcToCollection(), subjectMedicalHistorySet(), subjectMedicalHistorySetObject(), subjectMedicalHistorySetObjectId()

property suspectEntity as list of HS.FHIR.DTL.vSTU3.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()

property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

CodeableConcept

actual | potential

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

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

Feedback