Encounter
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
https://hl7.org/fhir/R4/encounter.html
Encounter creation in Canvas
An encounter is associated with some of our notes in Canvas. For our default base notes, an encounter will be created with these note types:
Lab visit
Phone visit
Telehealth visit
Office visit
Home Visit
In-patient Visit
Appointment Notes, once checked in, that are for the above visit types will be converted to an encounter.
See this Zendesk article for how to schedule an appointment.
With our Configurable Note Types Feature all custom note types will be associated with an encounter by default.
http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-encounter.html
Related guides:
Endpoints
Attributes
id
string
The identifier of the encounter
identifier
array[json]
Identifier(s) by which this encounter is known
status
string
The status of the encounter. Supported statuses are: planned, cancelled, finished, in-progress
class
json
Classification of patient encounter
type
array[json]
Specific type of encounter
subject
json
The patient or group present at the encounter
participant
array[json]
List of participants involved in the encounter
appointment
array[json]
The appointment that scheduled this encounter
period
json
The start and end time of the encounter
reasonCode
array[json]
Coded reason the encounter takes place
reasonReference
array[json]
Reason the encounter takes place (reference)
hospitalization
json
Details about the admission to a healthcare service
location
array[json]
List of locations where the patient has been during the encounter
get
/Encounter/{id}
Encounter read
Read an Encounter resource
Path Parameters
id required
string
The unique identifier for the Encounter
Responses
200 OK
Request was successful.
Errors
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Encounter
Encounter search
Search for Encounter resources
Query Parameters
_id
string
A Canvas-issued unique identifier
appointment
string
The appointment that scheduled this encounter
date
string
The start time of the encounter
patient
string
The patient or group present at the encounter
subject
string
Encounter subject
Responses
200 OK
Request was successful.
Errors
400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Encounter/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Encounter/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Encounter", "id": "7720a218-c0bd-4cee-82a2-729bd9c101f3", "identifier": [ { "id": "7720a218-c0bd-4cee-82a2-729bd9c101f3", "system": "http://canvasmedical.com", "value": "7720a218-c0bd-4cee-82a2-729bd9c101f3" } ], "status": "in-progress", "class": { "system": "https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "308335008", "display": "Office Visit" } ] } ], "subject": { "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2", "type": "Patient" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART", "display": "Participation" } ] } ], "period": { "start": "2022-04-04T05:26:34.711718+00:00" }, "individual": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner", "display": "Canvas Support MD" } } ], "period": { "start": "2022-04-04T05:26:34.711718+00:00" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "308335008", "display": "Patient encounter procedure (procedure)" } ] } ], "reasonReference": [ { "reference": "Condition/b06982fa-9bcb-4695-a2f4-09cfdb21f03d", "type": "Condition" }, { "reference": "Condition/e3df5e12-8ea4-46f8-922e-89a229945ef4", "type": "Condition" }, { "reference": "Condition/266eae2b-4983-42b7-94ca-1397f80a7968", "type": "Condition" } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition", "code": "oth", "display": "Other" } ] } }, "location": [ { "location": { "reference": "Location/50ea08f9-f4a5-4315-90e3-10d38922daa8", "type": "Location" } } ] }{ "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 Encounter resource '7d1ce256fcd7408193b0459650937a07'" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/Encounter?patient=Patient/8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15" 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": "/Encounter?patient=Patient%2F8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0" }, { "relation": "first", "url": "/Encounter?patient=Patient%2F8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0" }, { "relation": "last", "url": "/Encounter?patient=Patient%2F8f19219e36054ea89c4d98c9b258c2f1&date=ge2023-09-15&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "Encounter", "id": "06e0ee68-59f8-4899-b906-1298a36870ab", "identifier": [ { "id": "06e0ee68-59f8-4899-b906-1298a36870ab", "system": "http://canvasmedical.com", "value": "06e0ee68-59f8-4899-b906-1298a36870ab" } ], "status": "finished", "class": { "system": "https://www.hl7.org/fhir/v3/ActEncounterCode/vs.html" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "308335008", "display": "Office Visit" } ] } ], "subject": { "reference": "Patient/8f19219e36054ea89c4d98c9b258c2f1", "type": "Patient" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "PART", "display": "Participation" } ] } ], "period": { "start": "2023-09-20T18:41:54.885110+00:00", "end": "2023-09-20T18:57:47.490741+00:00" }, "individual": { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner", "display": "Larry Weed" } } ], "period": { "start": "2023-09-20T18:41:54.885110+00:00", "end": "2023-09-20T18:57:47.490741+00:00" }, "reasonCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "308335008", "display": "Patient encounter procedure (procedure)" } ] } ], "reasonReference": [ { "reference": "Condition/82e02680-c37d-4705-876d-b845d85efc20", "type": "Condition" } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/discharge-disposition", "code": "oth", "display": "Other" } ] } }, "location": [ { "location": { "reference": "Location/e332ff73-7fa4-4432-abe9-2adc43b1bb2c", "type": "Location" } } ] } } ] }{ "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" } } ] }