CareTeam
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html
All patients in Canvas have a CareTeam by default. The identifier for the CareTeam resource for a patient is the same as the patient identifier.
See our Zendesk article for information about setting up Care Teams and Care Team Roles in Canvas.
Endpoints
CareTeam read
Read a CareTeam resource.
Path Parameters
The default behavior is to return all active care team participants for the patient. To return care team participants of a different status, add .status at the end of the ID (e.g CareTeam/3e72c07b5aac4dc5929948f82c9afdfd.inactive).
Response Payload Attributes
The FHIR Resource name.
The identifier of the CareTeam.
The current state of the care team.
Name of the team.
This will always be set to Care Team for <patient_last_name>, <patient_first_name>
Who care team is for.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Display name of patient in the format <patient_last_name>, <patient_first_name>
Members of the team.
Canvas only allows practitioners to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam.
Canvas uses an extension to display whether a specific participant in a care team is the lead or not.
Reference that defines the content of this object.
Value of extension. If the value is set to True, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team.
Type of involvement
Code defined by a terminology system.
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
The system url of the coding.
The code of the care team role.
The display name of the coding.
Who is involved.
The reference string of the member in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Responses
Errors
CareTeam update
Update a CareTeam resource.
The CareTeam update endpoint acts as an upsert, so there is no CareTeam create endpoint. Any participants included in the payload will be the patient’s active care team participants. While any participants no longer included in the payload will be marked as inactive.
If-Unmodified-Since Header:
Due to a legacy design detail with the CareTeam implementation, there is a specific condition under which inclusion of this header will not produce expected results. In the case where all participants of a CareTeam are removed through the Canvas user interface (i.e. not through the FHIR API), the last modified date for the CareTeam will be equal to the last modified date of the patient record until another participant is added to the CareTeam.
More information about the If-Unmodified-Since header can be found in the Conditional Requests documentation.
Attributes
The FHIR Resource name.
The identifier of the CareTeam.
Who care team is for.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Members of the team.
Canvas only allows practitioners to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam.
If participant is omitted or sent as an empty list, Canvas will inactivate any care team participants it finds for the given subject.
Canvas supports the ability to mark a participant of a care team as the lead using a specific extension.
If this extension is omitted, any current care team lead designated in Canvas will stay as the lead.
Reference that defines the content of this object.
Value of extension. If the value is set to True, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team.
Type of involvement
Code defined by a terminology system.
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
The system url of the coding.
The code of the care team role.
The display name of the coding.
Who is involved.
The reference string of the member in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Responses
Canvas returns a
null response body.Errors
CareTeam search
Search for CareTeam resources.
Query Parameters
Who is involved.
Search to find all patient care teams that with a specific Practitioner member. Use the format "Practitioner/ed1e304acdb847148338c6b0596d93fd"
Search for a specific patient’s care team in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
Search for care team participants of a patient by a specific status. If a status is not specified to search by, note the id in the response batch will end in .status for all care teams that are not active statuses.
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 CareTeam.
The current state of the care team.
Name of the team.
This will always be set to Care Team for <patient_last_name>, <patient_first_name>
Who care team is for.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Display name of patient in the format <patient_last_name>, <patient_first_name>
Members of the team.
Canvas only allows practitioners to be members of a patient CareTeam. A practitioner can only have one role on a CareTeam, and only one practitioner can have a given role on a CareTeam.
Canvas uses an extension to display whether a specific participant in a care team is the lead or not.
Reference that defines the content of this object.
Value of extension. If the value is set to True, it indicates the specific participant as the lead for this care team. Only one active participant can be the lead of a care team.
Type of involvement
Code defined by a terminology system.
Needs to match a Care Team Role that is defined in the Settings of the Canvas instance.
The system url of the coding.
The code of the care team role.
The display name of the coding.
Who is involved.
The reference string of the member in the format of "Practitioner/ed1e304acdb847148338c6b0596d93fd".
Type the reference refers to (e.g. “Practitioner”).
Responses
Errors
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/CareTeam/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/CareTeam/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "CareTeam", "id": "8ab7cc3c86f54723ba267baf1f906ec7", "status": "active", "name": "Care Team for Amy V. Shaw", "subject": { "reference": "Patient/example", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": true } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": false } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453231000124104", "display": "Primary care provider" } ] } ], "member": { "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e", "display": "Kathy Fielding, MD" } } ] }{ "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 CareTeam resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }
curl --request PUT \ --url 'https://fumage-example.canvasmedical.com/CareTeam/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "CareTeam", "id": "8ab7cc3c86f54723ba267baf1f906ec7", "status": "active", "name": "Care Team for Amy V. Shaw", "subject": { "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": true } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": false } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453231000124104", "display": "Primary care provider" } ] } ], "member": { "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e", "display": "Kathy Fielding, MD" } } ] }'import requests url = "https://fumage-example.canvasmedical.com/CareTeam/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json" } payload = { "resourceType": "CareTeam", "id": "8ab7cc3c86f54723ba267baf1f906ec7", "status": "active", "name": "Care Team for Amy V. Shaw", "subject": { "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": True } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": False } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453231000124104", "display": "Primary care provider" } ] } ], "member": { "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e", "display": "Kathy Fielding, MD" } } ] } 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 CareTeam 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/CareTeam?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'import requests url = "https://fumage-example.canvasmedical.com/CareTeam?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": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" }, { "relation": "first", "url": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" }, { "relation": "last", "url": "/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "CareTeam", "id": "8ab7cc3c86f54723ba267baf1f906ec7", "status": "active", "name": "Care Team for Amy V. Shaw", "subject": { "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": true } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": false } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453231000124104", "display": "Primary care provider" } ] } ], "member": { "reference": "Practitioner/fc87cbb2525f4c5eb50294f620c7a15e", "display": "Kathy Fielding, MD" } } ] } }, { "resource": { "resourceType": "CareTeam", "id": "8ab7cc3c86f54723ba267baf1f906ec7.inactive", "status": "inactive", "name": "Care Team for Amy V. Shaw", "subject": { "reference": "Patient/8ab7cc3c86f54723ba267baf1f906ec7", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/careteam-lead", "valueBoolean": false } ], "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/390769eb976546ceaefe2507effcc665", "type": "Practitioner", "display": "Pat Byrnes" } } ] } } ] }{ "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" } } ] }