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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDetectedIssueThis is a DetectedIssue resource
identifierIdentifierBusiness identifier associated with the detected issue record.
statusstringIndicates the status of the detected issue.
categoryCodeableConceptIdentifies the general type of issue identified.
severitystringhigh|moderate|lowIndicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patientReferenceIndicates the patient whose record the detected issue is associated with.
datestringThe date or date-time when the detected issue was initially identified.
authorReferenceIndividual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicatedarray(Reference)Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detailstringA textual explanation of the detected issue.
referencestringThe literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigationarray(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

Patch Detected Issue

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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDetectedIssueThis is a DetectedIssue resource
identifierIdentifierBusiness identifier associated with the detected issue record.
statusstringIndicates the status of the detected issue.
categoryCodeableConceptIdentifies the general type of issue identified.
severitystringhigh|moderate|lowIndicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patientReferenceIndicates the patient whose record the detected issue is associated with.
datestringThe date or date-time when the detected issue was initially identified.
authorReferenceIndividual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicatedarray(Reference)Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detailstringA textual explanation of the detected issue.
referencestringThe literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigationarray(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

Read Detected Issue

get
/organizations/{organizationId}/fhir/3/DetectedIssue/{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 Detected Issue

get
/organizations/{organizationId}/fhir/3/DetectedIssue/{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 Detected Issue

get
/organizations/{organizationId}/fhir/3/DetectedIssue/{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 Detected Issue

delete
/organizations/{organizationId}/fhir/3/DetectedIssue/{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 Detected Issue

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
categorystring
datestring
identifierstring
implicatedstring
patientstring

Params

organizationId*string|stringid|slug

Response

Search History Detected Issue

get
/organizations/{organizationId}/fhir/3/DetectedIssue/_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 Detected Issue

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

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
categorystring
datestring
identifierstring
implicatedstring
patientstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDetectedIssueThis is a DetectedIssue resource
identifierIdentifierBusiness identifier associated with the detected issue record.
statusstringIndicates the status of the detected issue.
categoryCodeableConceptIdentifies the general type of issue identified.
severitystringhigh|moderate|lowIndicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patientReferenceIndicates the patient whose record the detected issue is associated with.
datestringThe date or date-time when the detected issue was initially identified.
authorReferenceIndividual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicatedarray(Reference)Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detailstringA textual explanation of the detected issue.
referencestringThe literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigationarray(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

Update Detected Issue

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDetectedIssueThis is a DetectedIssue resource
identifierIdentifierBusiness identifier associated with the detected issue record.
statusstringIndicates the status of the detected issue.
categoryCodeableConceptIdentifies the general type of issue identified.
severitystringhigh|moderate|lowIndicates the degree of importance associated with the identified issue based on the potential impact on the patient.
patientReferenceIndicates the patient whose record the detected issue is associated with.
datestringThe date or date-time when the detected issue was initially identified.
authorReferenceIndividual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
implicatedarray(Reference)Indicates the resource representing the current activity or proposed activity that is potentially problematic.
detailstringA textual explanation of the detected issue.
referencestringThe literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
mitigationarray(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