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.
https://www.hl7.org/fhir/R4/detectedissue.html
DetectedIssue create
Create an DetectedIssue.
Attributes
The FHIR Resource name.
External identifiers associated with this DetectedIssue.
The identifier field allows for one external identifier to be stored for each DetectedIssue. This identifier may help users identify the issue in their own systems, particularly if the DetectedIssue was added from an external system or source.
The namespace for the identifier value.
The unique value for the identifier within the specified system.
The status of the DetectedIssue.
There is some extra validation when creating/updating depending on what is supplied in the mitigation attribute
- The status must be registered if no mitigation is supplied.
- If there is only one mitigation supplied and the action of that mitigation is valid, the status must be preliminary.
- If there is only one mitigation supplied and the action of that mitigation is invalid, the status must be cancelled.
- If there are more than one mitigation and the one with the latest date has an action of deferred, the status must be amended.
- If there are more than one mitigation and the one with the latest date has an action of accepted or refuted, the status must be final.
- If there are more than one mitigation and the one with the latest date has an action of corrected, the status must be corrected.
Identifies the general type of issue identified.
Code defined by a terminology system.
The system url of the coding.
The code that identifies the general type of issue identified.
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
The patient for the DetectedIssue record.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The datetime when the detected issue was identified.
Individual or device responsible for the issue being raised.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
There must be at least one evidence element with system “http://hl7.org/fhir/sid/icd-10-cm”.
A manifestation that led to the recording of this detected issue.
Code defined by a terminology system.
The system url of the coding.
The code of the Evidence.
The display name of the coding.
A textual explanation of the detected issue.
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Code defined by a terminology system.
The system url of the coding.
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
If only one mitigation is supplied, the action must be either valid or invalid.
If there are more than one mitigation, the one with the earliest date must be valid. The rest of the mitigations that are not the last date will need to have an action of deferred. While the final mitigation can have a status of deferred, accepted, refuted or corrected.
The datetime when the mitigation action was taken or committed to be taken.
Individual or device responsible for the mitigation action.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Responses
Canvas returns the created resource's id as a UUID within the
location header and a null response body.Errors
DetectedIssue read
Read an DetectedIssue.
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The Canvas identifier of the DetectedIssue.
External identifiers associated with this DetectedIssue.
The namespace for the identifier value.
The unique value for the identifier within the specified system.
The status of the DetectedIssue.
Identifies the general type of issue identified.
Code defined by a terminology system.
The system url of the coding.
The code that identifies the general type of issue identified.
The display name of the coding.
Plain text representation of the coding.
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
The patient for the DetectedIssue record.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The datetime when the detected issue was identified.
Individual or device responsible for the issue being raised.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
A manifestation that led to the recording of this detected issue.
Code defined by a terminology system.
The system url of the coding.
The code of the Evidence.
The display name of the coding.
A textual explanation of the detected issue.
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
The Canvas identifier of the DetectedIssueMitigation.
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Code defined by a terminology system.
The system url of the coding.
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
The display name of the coding
The datetime when the mitigation action was taken or committed to be taken.
Individual or device responsible for the mitigation action.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Responses
Errors
DetectedIssue update
Update an DetectedIssue.
Attributes
The FHIR Resource name.
The Canvas identifier of the DetectedIssue.
External identifiers associated with this DetectedIssue.
The identifier field allows for one external identifier to be stored for each DetectedIssue. This identifier may help users identify the issue in their own systems, particularly if the DetectedIssue was added from an external system or source.
The namespace for the identifier value.
The unique value for the identifier within the specified system.
The status of the DetectedIssue.
There is some extra validation when creating/updating depending on what is supplied in the mitigation attribute
- The status must be registered if no mitigation is supplied.
- If there is only one mitigation supplied and the action of that mitigation is valid, the status must be preliminary.
- If there is only one mitigation supplied and the action of that mitigation is invalid, the status must be cancelled.
- If there are more than one mitigation and the one with the latest date has an action of deferred, the status must be amended.
- If there are more than one mitigation and the one with the latest date has an action of accepted or refuted, the status must be final.
- If there are more than one mitigation and the one with the latest date has an action of corrected, the status must be corrected.
Identifies the general type of issue identified.
Code defined by a terminology system.
The system url of the coding.
The code that identifies the general type of issue identified.
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
The patient for the DetectedIssue record.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The datetime when the detected issue was identified.
Individual or device responsible for the issue being raised.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
When updating attributes, make sure to supply the id field for the evidences that already exist in Canvas so they are not duplicated or removed.
There must be at least one evidence element with system “http://hl7.org/fhir/sid/icd-10-cm”.
A manifestation that led to the recording of this detected issue.
Code defined by a terminology system.
The system url of the coding.
The code of the Evidence.
The display name of the coding.
A textual explanation of the detected issue.
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
When updating attributes, make sure to supply the id field for the mitigations that already exist in Canvas so they are not duplicated or removed.
The Canvas identifier of the DetectedIssueMitigation.
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Code defined by a terminology system.
The system url of the coding.
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
If only one mitigation is supplied, the action must be either valid or invalid.
If there are more than one mitigation, the one with the earliest date must be valid. The rest of the mitigations that are not the last date will need to have an action of deferred. While the final mitigation can have a status of deferred, accepted, refuted or corrected.
The datetime when the mitigation action was taken or committed to be taken.
Individual or device responsible for the mitigation action.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Responses
Errors
DetectedIssue search
Search an DetectedIssue.
Query Parameters
A Canvas-issued unique identifier for a specific DetectedIssue.
The patient for the DetectedIssue record in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
The status of the DetectedIssue.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The Canvas identifier of the DetectedIssue.
External identifiers associated with this DetectedIssue.
The namespace for the identifier value.
The unique value for the identifier within the specified system.
The status of the DetectedIssue.
Identifies the general type of issue identified.
Code defined by a terminology system.
The system url of the coding.
The code that identifies the general type of issue identified.
The display name of the coding.
Plain text representation of the coding.
Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
The patient for the DetectedIssue record.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The datetime when the detected issue was identified.
Individual or device responsible for the issue being raised.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Supporting evidence or manifestations that provide the basis for identifying the detected issue.
A manifestation that led to the recording of this detected issue.
Code defined by a terminology system.
The system url of the coding.
The code of the Evidence.
The display name of the coding.
A textual explanation of the detected issue.
The literature, knowledge base, or similar reference that describes the propensity for the detected issue identified. This field requires a valid URL representing the reference.
Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
The Canvas identifier of the DetectedIssueMitigation.
The type of action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting.
Code defined by a terminology system.
The system url of the coding.
Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
The display name of the coding
The datetime when the mitigation action was taken or committed to be taken.
Individual or device responsible for the mitigation action.
The reference string of the author in the format of "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f".
Type the reference refers to (e.g. “Practitioner”).
Responses
Errors
curl --request POST \ --url 'https://fumage-example.canvasmedical.com/DetectedIssue' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "DetectedIssue", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP" } ] }, "severity": "moderate", "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] }'import requests url = "https://fumage-example.canvasmedical.com/DetectedIssue" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json", } payload = { "resourceType": "DetectedIssue", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP" } ] }, "severity": "moderate", "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] }
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/DetectedIssue/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/DetectedIssue/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "DetectedIssue", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP", "display": "Codinggap" } ], "text": "Codinggap" }, "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698", "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown DetectedIssue resource 'd9aefede-da05-4bef-bbf9-63bcf83c806b'" } } ] }
curl --request POST \ --url 'https://fumage-example.canvasmedical.com/DetectedIssue/d9aefede-da05-4bef-bbf9-63bcf83c806a' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "DetectedIssue", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP" } ] }, "severity": "moderate", "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698", "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] }'import requests url = "https://fumage-example.canvasmedical.com/DetectedIssue/d9aefede-da05-4bef-bbf9-63bcf83c806a" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json", } payload = { "resourceType": "DetectedIssue", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP" } ] }, "severity": "moderate", "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698", "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] }
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/DetectedIssue?patient=Patient/a39cafb9d1b445be95a2e2548e12a787' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/DetectedIssue?patient=Patient/a39cafb9d1b445be95a2e2548e12a787" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0" }, { "relation": "first", "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0" }, { "relation": "last", "url": "/DetectedIssue?patient=Patient%2Fa39cafb9d1b445be95a2e2548e12a787&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "DetectedIssue", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "identifier": [ { "system": "http://external.identifier.system/url", "value": "080abebd" } ], "status": "preliminary", "code": { "coding": [ { "system": "https://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "CODINGGAP", "display": "Codinggap" } ], "text": "Codinggap" }, "patient": { "reference": "Patient/a39cafb9d1b445be95a2e2548e12a787", "type": "Patient" }, "identifiedDateTime": "2024-08-10T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" }, "evidence": [ { "code": [ { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "I23.43", "display": "Code text explanation" } ] } ] } ], "detail": "Detail for detected issue", "reference": "https://example.com", "mitigation": [ { "id": "9a1cfc8c-4ee9-4eb7-9658-a5b0f9576698", "action": { "coding": [ { "system": "https://schemas.canvasmedical.com/fhir/detectedissue-mitigation-action", "code": "valid" } ] }, "date": "2024-08-09T14:23:08+00:00", "author": { "reference": "Practitioner/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Practitioner" } } ] } } ] }