adverse events

Create Adverse Event

post
/organizations/{organizationId}/fhir/3/AdverseEvent

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringAdverseEventThis is a AdverseEvent resource
identifierIdentifierThe identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
categorystringAE|PAEThe type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
typeCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subjectReferenceThis subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
datestringThe date (and perhaps time) when the adverse event occurred.
reactionarray(Reference)Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
locationReferenceThe information about where the adverse event occurred.
seriousnessCodeableConceptDescribes the seriousness or severity of the adverse event.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
eventParticipantReferenceParties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
descriptionstringDescribes the adverse event in text.
suspectEntityarray(AdverseEvent_SuspectEntity)Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistoryarray(Reference)AdverseEvent.subjectMedicalHistory.
referenceDocumentarray(Reference)AdverseEvent.referenceDocument.
studyarray(Reference)AdverseEvent.study.

Response

Patch Adverse Event

patch
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAdverseEventThis is a AdverseEvent resource
identifierIdentifierThe identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
categorystringAE|PAEThe type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
typeCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subjectReferenceThis subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
datestringThe date (and perhaps time) when the adverse event occurred.
reactionarray(Reference)Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
locationReferenceThe information about where the adverse event occurred.
seriousnessCodeableConceptDescribes the seriousness or severity of the adverse event.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
eventParticipantReferenceParties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
descriptionstringDescribes the adverse event in text.
suspectEntityarray(AdverseEvent_SuspectEntity)Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistoryarray(Reference)AdverseEvent.subjectMedicalHistory.
referenceDocumentarray(Reference)AdverseEvent.referenceDocument.
studyarray(Reference)AdverseEvent.study.

Response

Read Adverse Event

get
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Adverse Event

get
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Adverse Event

get
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Adverse Event

delete
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Adverse Event

get
/organizations/{organizationId}/fhir/3/AdverseEvent

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
locationstring
reactionstring
recorderstring
seriousnessstring
studystring
subjectstring
substancestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Adverse Event

get
/organizations/{organizationId}/fhir/3/AdverseEvent/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Adverse Event

post
/organizations/{organizationId}/fhir/3/AdverseEvent/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
locationstring
reactionstring
recorderstring
seriousnessstring
studystring
subjectstring
substancestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringAdverseEventThis is a AdverseEvent resource
identifierIdentifierThe identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
categorystringAE|PAEThe type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
typeCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subjectReferenceThis subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
datestringThe date (and perhaps time) when the adverse event occurred.
reactionarray(Reference)Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
locationReferenceThe information about where the adverse event occurred.
seriousnessCodeableConceptDescribes the seriousness or severity of the adverse event.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
eventParticipantReferenceParties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
descriptionstringDescribes the adverse event in text.
suspectEntityarray(AdverseEvent_SuspectEntity)Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistoryarray(Reference)AdverseEvent.subjectMedicalHistory.
referenceDocumentarray(Reference)AdverseEvent.referenceDocument.
studyarray(Reference)AdverseEvent.study.

Response

Update Adverse Event

put
/organizations/{organizationId}/fhir/3/AdverseEvent/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringAdverseEventThis is a AdverseEvent resource
identifierIdentifierThe identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
categorystringAE|PAEThe type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
typeCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subjectReferenceThis subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
datestringThe date (and perhaps time) when the adverse event occurred.
reactionarray(Reference)Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
locationReferenceThe information about where the adverse event occurred.
seriousnessCodeableConceptDescribes the seriousness or severity of the adverse event.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
eventParticipantReferenceParties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
descriptionstringDescribes the adverse event in text.
suspectEntityarray(AdverseEvent_SuspectEntity)Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistoryarray(Reference)AdverseEvent.subjectMedicalHistory.
referenceDocumentarray(Reference)AdverseEvent.referenceDocument.
studyarray(Reference)AdverseEvent.study.

Response