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
Attributes
The identifier of the CareTeam
The default behavior is to return all active care team memberships for the patient. To return care team members of a different status, add .status
at the end of the ID. Example: 3e72c07b5aac4dc5929948f82c9afdfd.inactive
The current state of the care team
Supported codes for update interactions are: proposed, active, suspended, inactive
Name of the team, such as crisis assessment team
Who care team is for
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.
CareTeam read
Read a CareTeam resource.
Path Parameters
Responses
Errors
CareTeam update
Update a CareTeam resource.
The CareTeam update endpoint acts as an upsert, so there is no CareTeam create
endpoint.
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 members 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 member is added to the CareTeam.
More information about the If-Unmodified-Since header can be found in the Conditional Requests documentation.
Attributes
The identifier of the CareTeam
The default behavior is to return all active care team memberships for the patient. To return care team members of a different status, add .status
at the end of the ID. Example: 3e72c07b5aac4dc5929948f82c9afdfd.inactive
The current state of the care team
Supported codes for update interactions are: proposed, active, suspended, inactive
Name of the team, such as crisis assessment team
Who care team is for
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.
Responses
Errors
CareTeam search
Search for CareTeam resources.
Query Parameters
Who is involved
Supported reference types: Practitioner
Who care team is for
The current state of the care team
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": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "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": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "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": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "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%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'
import requests url = "https://fumage-example.canvasmedical.com/CareTeam?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0" 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/example", "type": "Patient", "display": "Amy V. Shaw" }, "participant": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "17561000", "display": "Cardiologist" } ] } ], "member": { "reference": "Practitioner/c2ff4546548e46ab8959af887b563eab", "display": "Ronald Bone, MD" } }, { "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": "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" } } ] }