detected issues

Create Detected Issue

post

/organizations/{organizationId}/fhir/3/DetectedIssue

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Request

Headers


content-type*	string	application/json	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	DetectedIssue	This is a DetectedIssue resource
identifier	Identifier		Business identifier associated with the detected issue record.
status	string		Indicates the status of the detected issue.
category	CodeableConcept		Identifies the general type of issue identified.
severity	string	high\|moderate\|low	Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patient	Reference		Indicates the patient whose record the detected issue is associated with.
date	string		The date or date-time when the detected issue was initially identified.
author	Reference		Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicated	array(Reference)		Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detail	string		A textual explanation of the detected issue.
reference	string		The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigation	array(DetectedIssue_Mitigation)		Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Response

201 400 401 404

Patch Detected Issue

patch

/organizations/{organizationId}/fhir/3/DetectedIssue/{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	DetectedIssue	This is a DetectedIssue resource
identifier	Identifier		Business identifier associated with the detected issue record.
status	string		Indicates the status of the detected issue.
category	CodeableConcept		Identifies the general type of issue identified.
severity	string	high\|moderate\|low	Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patient	Reference		Indicates the patient whose record the detected issue is associated with.
date	string		The date or date-time when the detected issue was initially identified.
author	Reference		Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicated	array(Reference)		Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detail	string		A textual explanation of the detected issue.
reference	string		The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigation	array(DetectedIssue_Mitigation)		Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Response

200 201 400 401 404 409

Read Detected Issue

get

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

Request

Headers


content-type*	string	application/json	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 Detected Issue

get

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

Request

Headers


content-type*	string	application/json	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 Detected Issue

get

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

Request

Headers


content-type*	string	application/json	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 Detected Issue

delete

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

Request

Headers


content-type*	string	application/json	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 Detected Issue

get

/organizations/{organizationId}/fhir/3/DetectedIssue

Request

Headers


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

Query params


_id	string
_language	string
author	string
category	string
date	string
identifier	string
implicated	string
patient	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Detected Issue

get

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

Request

Headers


content-type*	string	application/json	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 Detected Issue

post

/organizations/{organizationId}/fhir/3/DetectedIssue/_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
author	string
category	string
date	string
identifier	string
implicated	string
patient	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	DetectedIssue	This is a DetectedIssue resource
identifier	Identifier		Business identifier associated with the detected issue record.
status	string		Indicates the status of the detected issue.
category	CodeableConcept		Identifies the general type of issue identified.
severity	string	high\|moderate\|low	Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patient	Reference		Indicates the patient whose record the detected issue is associated with.
date	string		The date or date-time when the detected issue was initially identified.
author	Reference		Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicated	array(Reference)		Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detail	string		A textual explanation of the detected issue.
reference	string		The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigation	array(DetectedIssue_Mitigation)		Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Response

200 401 404

Update Detected Issue

put

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

Request

Headers


content-type*	string	application/json	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	DetectedIssue	This is a DetectedIssue resource
identifier	Identifier		Business identifier associated with the detected issue record.
status	string		Indicates the status of the detected issue.
category	CodeableConcept		Identifies the general type of issue identified.
severity	string	high\|moderate\|low	Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patient	Reference		Indicates the patient whose record the detected issue is associated with.
date	string		The date or date-time when the detected issue was initially identified.
author	Reference		Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicated	array(Reference)		Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detail	string		A textual explanation of the detected issue.
reference	string		The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigation	array(DetectedIssue_Mitigation)		Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Response

200 201 400 401 404 409