adverse events

Create Adverse Event

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a AdverseEvent resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
actualityactual|potentialWhether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
categoryarray(CodeableConcept)The overall type of event, intended for search and filtering purposes.
eventCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subject*ReferenceThis subject or group impacted by the event.
encounterReferenceThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
datedateTimeThe date (and perhaps time) when the adverse event occurred.
detecteddateTimeEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
recordedDatedateTimeThe date on which the existence of the AdverseEvent was first recorded.
resultingConditionarray(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.
seriousnessCodeableConceptAssessment whether this event was of real importance.
severityCodeableConceptDescribes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
contributorarray(Reference)Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
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/4/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*This is a AdverseEvent resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
actualityactual|potentialWhether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
categoryarray(CodeableConcept)The overall type of event, intended for search and filtering purposes.
eventCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subject*ReferenceThis subject or group impacted by the event.
encounterReferenceThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
datedateTimeThe date (and perhaps time) when the adverse event occurred.
detecteddateTimeEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
recordedDatedateTimeThe date on which the existence of the AdverseEvent was first recorded.
resultingConditionarray(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.
seriousnessCodeableConceptAssessment whether this event was of real importance.
severityCodeableConceptDescribes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
contributorarray(Reference)Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
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/4/AdverseEvent/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Adverse Event

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/AdverseEvent/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Adverse Event

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Adverse Event

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

Request

Headers

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

Query params

_idstring
_languagestring
actualitystring
categorystring
datestring
locationstring
recorderstring
resultingconditionstring
seriousnessstring
severitystring
studystring
subjectstring
substancestring

Params

organizationId*string|stringid|slug

Response

Search History Adverse Event

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
actualitystring
categorystring
datestring
locationstring
recorderstring
resultingconditionstring
seriousnessstring
severitystring
studystring
subjectstring
substancestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a AdverseEvent resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
actualityactual|potentialWhether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
categoryarray(CodeableConcept)The overall type of event, intended for search and filtering purposes.
eventCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subject*ReferenceThis subject or group impacted by the event.
encounterReferenceThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
datedateTimeThe date (and perhaps time) when the adverse event occurred.
detecteddateTimeEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
recordedDatedateTimeThe date on which the existence of the AdverseEvent was first recorded.
resultingConditionarray(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.
seriousnessCodeableConceptAssessment whether this event was of real importance.
severityCodeableConceptDescribes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
contributorarray(Reference)Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a AdverseEvent resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierBusiness identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
actualityactual|potentialWhether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
categoryarray(CodeableConcept)The overall type of event, intended for search and filtering purposes.
eventCodeableConceptThis element defines the specific type of event that occurred or that was prevented from occurring.
subject*ReferenceThis subject or group impacted by the event.
encounterReferenceThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
datedateTimeThe date (and perhaps time) when the adverse event occurred.
detecteddateTimeEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
recordedDatedateTimeThe date on which the existence of the AdverseEvent was first recorded.
resultingConditionarray(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.
seriousnessCodeableConceptAssessment whether this event was of real importance.
severityCodeableConceptDescribes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
outcomeCodeableConceptDescribes the type of outcome from the adverse event.
recorderReferenceInformation on who recorded the adverse event. May be the patient or a practitioner.
contributorarray(Reference)Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
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