Overview
Care Team Members Information addresses:
- CareTeam HL7® FHIR® resource with US Core Profile 6.1.0
The CareTeam includes all the people, teams, and organizations who plan to participate in the coordination and delivery of care for a single patient or a group. This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Care Team Member Information.
Care team members or participants include practitioners (physicians, nurses, technicians, etc.), family members, friends, guardians, and the patient. The care team can be specific to an encounter or to the patient across all encounters (longitudinal).
Each CareTeam has next elements:
- a patient
- a participant role for each careteam members
- a reference to each careteam member which can be:
- a practitioner or practitioner type (doctor, nurse, therapist)
- a relative or friend or guardian
Each CareTeam must support:
- a status code
Profile specific implementation guidance:
In order to access care team member’s names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:
- US Core Practitioner Profile
- US Core PractitionerRole Profile
- US Core RelatedPerson Profile
Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references (and _include search parameters), but SHALL support at least one of them.
The client application SHALL support all three profile references.
Because the US Core PractitionerRole Profile supplies the provider’s location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile. An example of how to access the practitioner name and identifier is shown in the quick start section below.
Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
This resource conforms to USCDI v3 for Care Team Members - refers to US Core CareTeam Profile 6.1.0. CareTeam response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.
| USCDI | USCore Data Element | FHIR Resource Field |
|---|---|---|
| Care Team Member Name | US Core Practitioner Profile | CarePlan.participant.member.name |
| Care Team Member Identifier | US Core Practitioner Profile | CarePlan.participant.member.identifier |
| Care Team Member Location | US Core Practitioner Profile | CarePlan.participant.member.address |
| Care Team Member Telecom | US Core Practitioner Profile | CareTeam.participant.member.telecom |
| Care Team Member Role | US Core Practitioner Profile | CareTeam.participant.role |
Must support elements, mandatory and optional search parameters
CareTeammust support these elements:
statussubjectparticipantrolemember
Each CareTeam Must Have (Mandatory):
subjectparticipantrolemember
The following search parameters and search parameter combinations SHALL be supported:
The syntax used to describe the interactions is described here.
SHALL support searching using the combination of the patient and status search parameters:
- including optional support for these
_includeparameters:CareTeam:participant:PractitionerRoleCareTeam:participant:PractitionerCareTeam:participant:PatientCareTeam:participant:RelatedPerson
- including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)
GET [base url]/CareTeam?patient={Type/}[id]&status=active
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and role search parameters:
- including optional support for these
_includeparameters:CareTeam:participant:PractitionerRoleCareTeam:participant:PractitionerCareTeam:participant:PatientCareTeam:participant:RelatedPerson
GET [base url]/CareTeam?patient={Type/}[id]&role={system|}[code]
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
CareTeam by Patient and Status
Search for CareTeam using combination of patient and status parameters.
METHOD GET
GET [base url]/CareTeam?patient={Type/}[id]&status=activePARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CareTeam?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&status=active' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'CareTeam by Patient and Status with Include Parameters
Search for CareTeam with included participant resources.
METHOD GET
GET [base url]/CareTeam?patient={Type/}[id]&status=active&_include=CareTeam:participant:PractitionerRole&_include=CareTeam:participant:Practitioner&_include=CareTeam:participant:Patient&_include=CareTeam:participant:RelatedPersonPARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
_include - Include related participant resources in the response bundle
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CareTeam?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&status=active&_include=CareTeam:participant:PractitionerRole&_include=CareTeam:participant:RelatedPerson' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'CareTeam by Patient and Role
Search for CareTeam using combination of patient and role parameters.
METHOD GET
GET [base url]/CareTeam?patient={Type/}[id]&role={system|}[code]PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Role system. FHIR search token parameter. See Search specification for more information. Example: http://snomed.info/sct|
[code] - Role code. Example: 223366009 (Healthcare professional)
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/CareTeam?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&role=http://snomed.info/sct|223366009' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'