Condition
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-condition.html
Condition create
Create a Condition resource.
This endpoint does not prevent duplicates in the record. Canvas recommends performing a search prior to adding a new condition to confirm whether the condition has already been created for the patient.
If clinicalStatus is active, the Condition will be added as a Diagnose command. If it is not active, the Condition will be added as a Past Medical History command.
If an encounter or a note ID in the extension is provided, the Condition will be added to the existing encounter (note). If it is not provided, a new data import note will be created.
Attributes
The FHIR Resource name.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Reference that defines the content of this object.
The valueId field is used for the Note extension and will be the note’s unique identifier.
The clinical status of the condition.
If clinicalStatus is active, the Condition will be added as a Diagnose command. If it is not active, the Condition will be added as a Past Medical History command.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
A category assigned to the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
Identification of the condition, problem or diagnosis.
Canvas will not validate the coding supplied in the payload, instead Canvas will just save the system, code, and display as provided. We highly recommend supplying a coding with the system of http://hl7.org/fhir/sid/icd-10-cm.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
Who has the condition.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Encounter created as part of
Canvas does not currently support concurrent creation of resources on the same encounter. Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
The reference string of the encounter in the format of "Encounter/f7663d7b-13bd-4236-843e-086306aea125".
Type the reference refers to (e.g. “Encounter”).
Estimated or actual date.
When in resolution/remission.
Date-time record was first recorded.
If ommitted it will default to the timestamp of ingestion into Canvas.
If ommitted, this will default to Canvas Bot.
The reference string of the subject in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
The annotation - text content.
Responses
Canvas returns the created resource's id as a UUID within the
location header and a null response body.Errors
Condition read
Read a Condition resource.
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The identifier of the Condition.
Text summary of the Condition, for human interpretation.
The status of the narrative.
Limited xhtml content that contains the human readable text of the Condition.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Reference that defines the content of this object.
The valueId field is used for the Note extension and will be the note’s unique identifier.
The clinical status of the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
The verification status to support the clinical status of the condition.
A confirmed status corresponds to committed conditions from a Diagnose or Past Medical History command. An entered-in-error status means the Diagnose or Past Medical History command was entered-in-error. A provisional condition means it was added as an indication to either Image, Refer, POC Lab Test, or a Lab Order command.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
A category assigned to the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
Identification of the condition, problem or diagnosis.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Who has the condition.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Encounter created as part of
The reference string of the encounter in the format of "Encounter/f7663d7b-13bd-4236-843e-086306aea125".
Type the reference refers to (e.g. “Encounter”).
Estimated or actual date.
When in resolution/remission.
Date-time record was first recorded.
Who recorded the condition.
The reference string of the subject in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
The annotation - text content.
Responses
Errors
Condition update
Update a Condition resource.
The only type of Condition update interaction that is supported by Canvas is to mark an existing Condition as entered-in-error. No changes to other fields will be processed. All required fields must still be provided, but out FHIR Update will assume a call to the FHIR Condition Update is an intention to mark the condition as entered-in-error.
Attributes
The FHIR Resource name.
The identifier of the Condition.
The clinical status of the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
A category assigned to the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
Identification of the condition, problem or diagnosis.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
Who has the condition.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
On an Update this Practitioner will become the user in Canvas who marked the Condition as entered-in-error. If ommitted, it will default to Canvas Bot.
The reference string of the subject in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Responses
Canvas returns a
null response body.Errors
Condition search
Search for Condition resources.
Query Parameters
The identifier of the Condition.
The clinical status of the condition.
The patient reference associated to the Condition in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
The verification status to support the clinical status of the condition.
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 identifier of the Condition.
Text summary of the Condition, for human interpretation.
The status of the narrative.
Limited xhtml content that contains the human readable text of the Condition.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Reference that defines the content of this object.
The valueId field is used for the Note extension and will be the note’s unique identifier.
The clinical status of the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
The verification status to support the clinical status of the condition.
A confirmed status corresponds to committed conditions from a Diagnose or Past Medical History command. An entered-in-error status means the Diagnose or Past Medical History command was entered-in-error. A provisional condition means it was added as an indication to either Image, Refer, POC Lab Test, or a Lab Order command.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
A category assigned to the condition.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Plain text representation of the concept.
Identification of the condition, problem or diagnosis.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the clinical status.
The display name of the coding.
Who has the condition.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Encounter created as part of
The reference string of the encounter in the format of "Encounter/f7663d7b-13bd-4236-843e-086306aea125".
Type the reference refers to (e.g. “Encounter”).
Estimated or actual date.
When in resolution/remission.
Date-time record was first recorded.
Who recorded the condition.
The reference string of the subject in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Additional information about the Condition. This note only appears in the Canvas UI for resolved conditions.
The annotation - text content.
Responses
Errors
curl --request POST \ --url 'https://fumage-example.canvasmedical.com/Condition' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Condition", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "Confirmed" } ], "text": "Confirmed" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] }'import requests url = "https://fumage-example.canvasmedical.com/Condition" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json" } payload = { "resourceType": "Condition", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "Confirmed" } ], "text": "Confirmed" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] } response = requests.post(url, json=payload, headers=headers) print(response.text)
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/Condition/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Condition/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Condition", "id": "3340c331-d446-4700-9c23-7959bd393f26", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "Confirmed" } ], "text": "Confirmed" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] }{ "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 Condition resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }
curl --request PUT \ --url 'https://fumage-example.canvasmedical.com/Condition/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Condition", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "entered-in-error", "display": "Entered in Error" } ], "text": "Entered in Error" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] }'import requests url = "https://fumage-example.canvasmedical.com/Condition/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json" } payload = { "resourceType": "Condition", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "entered-in-error", "display": "Entered in Error" } ], "text": "Entered in Error" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] } response = requests.put(url, json=payload, headers=headers) print(response.text)
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-found", "details": { "text": "Unknown Condition resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "conflict", "details": { "text": "Resource updated since If-Unmodified-Since date" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Condition?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Condition?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" 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": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" }, { "relation": "first", "url": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" }, { "relation": "last", "url": "/Condition?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "Condition", "id": "3340c331-d446-4700-9c23-7959bd393f26", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", "code": "resolved", "display": "Resolved" } ], "text": "Resolved" }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", "code": "confirmed", "display": "Confirmed" } ], "text": "Confirmed" }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "Encounter Diagnosis" } ], "code": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10-cm", "code": "V97.21XS", "display": "Parachutist entangled in object, sequela" } ], "text": "Parachutist entangled in object, sequela" }, "subject": { "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0" }, "encounter": { "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc" }, "onsetDateTime": "2023-06-15", "abatementDateTime": "2023-06-17", "recordedDate": "2023-06-18T15:00:00-04:00", "recorder": { "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39" }, "note": [ { "text": "Condition note" } ] } } ] }{ "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" } } ] }