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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	AdverseEvent	This is a AdverseEvent resource
identifier	Identifier		The 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.
category	string	AE\|PAE	The 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.
type	CodeableConcept		This element defines the specific type of event that occurred or that was prevented from occurring.
subject	Reference		This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
date	string		The date (and perhaps time) when the adverse event occurred.
reaction	array(Reference)		Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
location	Reference		The information about where the adverse event occurred.
seriousness	CodeableConcept		Describes the seriousness or severity of the adverse event.
outcome	CodeableConcept		Describes the type of outcome from the adverse event.
recorder	Reference		Information on who recorded the adverse event. May be the patient or a practitioner.
eventParticipant	Reference		Parties 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).
description	string		Describes the adverse event in text.
suspectEntity	array(AdverseEvent_SuspectEntity)		Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistory	array(Reference)		AdverseEvent.subjectMedicalHistory.
referenceDocument	array(Reference)		AdverseEvent.referenceDocument.
study	array(Reference)		AdverseEvent.study.

Response

201 400 401 404

Patch Adverse Event

patch

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	AdverseEvent	This is a AdverseEvent resource
identifier	Identifier		The 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.
category	string	AE\|PAE	The 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.
type	CodeableConcept		This element defines the specific type of event that occurred or that was prevented from occurring.
subject	Reference		This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
date	string		The date (and perhaps time) when the adverse event occurred.
reaction	array(Reference)		Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
location	Reference		The information about where the adverse event occurred.
seriousness	CodeableConcept		Describes the seriousness or severity of the adverse event.
outcome	CodeableConcept		Describes the type of outcome from the adverse event.
recorder	Reference		Information on who recorded the adverse event. May be the patient or a practitioner.
eventParticipant	Reference		Parties 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).
description	string		Describes the adverse event in text.
suspectEntity	array(AdverseEvent_SuspectEntity)		Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistory	array(Reference)		AdverseEvent.subjectMedicalHistory.
referenceDocument	array(Reference)		AdverseEvent.referenceDocument.
study	array(Reference)		AdverseEvent.study.

Response

200 201 400 401 404 409

Read Adverse Event

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Adverse Event

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Adverse Event

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Adverse Event

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Adverse Event

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
category	string
date	string
location	string
reaction	string
recorder	string
seriousness	string
study	string
subject	string
substance	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Adverse Event

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Adverse Event

post

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
category	string
date	string
location	string
reaction	string
recorder	string
seriousness	string
study	string
subject	string
substance	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	AdverseEvent	This is a AdverseEvent resource
identifier	Identifier		The 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.
category	string	AE\|PAE	The 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.
type	CodeableConcept		This element defines the specific type of event that occurred or that was prevented from occurring.
subject	Reference		This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
date	string		The date (and perhaps time) when the adverse event occurred.
reaction	array(Reference)		Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
location	Reference		The information about where the adverse event occurred.
seriousness	CodeableConcept		Describes the seriousness or severity of the adverse event.
outcome	CodeableConcept		Describes the type of outcome from the adverse event.
recorder	Reference		Information on who recorded the adverse event. May be the patient or a practitioner.
eventParticipant	Reference		Parties 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).
description	string		Describes the adverse event in text.
suspectEntity	array(AdverseEvent_SuspectEntity)		Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistory	array(Reference)		AdverseEvent.subjectMedicalHistory.
referenceDocument	array(Reference)		AdverseEvent.referenceDocument.
study	array(Reference)		AdverseEvent.study.

Response

200 401 404

Update Adverse Event

put

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	AdverseEvent	This is a AdverseEvent resource
identifier	Identifier		The 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.
category	string	AE\|PAE	The 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.
type	CodeableConcept		This element defines the specific type of event that occurred or that was prevented from occurring.
subject	Reference		This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
date	string		The date (and perhaps time) when the adverse event occurred.
reaction	array(Reference)		Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
location	Reference		The information about where the adverse event occurred.
seriousness	CodeableConcept		Describes the seriousness or severity of the adverse event.
outcome	CodeableConcept		Describes the type of outcome from the adverse event.
recorder	Reference		Information on who recorded the adverse event. May be the patient or a practitioner.
eventParticipant	Reference		Parties 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).
description	string		Describes the adverse event in text.
suspectEntity	array(AdverseEvent_SuspectEntity)		Describes the entity that is suspected to have caused the adverse event.
subjectMedicalHistory	array(Reference)		AdverseEvent.subjectMedicalHistory.
referenceDocument	array(Reference)		AdverseEvent.referenceDocument.
study	array(Reference)		AdverseEvent.study.

Response

200 201 400 401 404 409