Skip to content

FHIR Care Team Members

Overview

Care Team Members addresses to the CareTeam HL7® FHIR® resource. The FHIR 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.

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 care team members
  • a reference to each care team member which can be:
    • a practitioner or practitioner type (doctor, nurse, therapist)
    • the patient
    • a relative or friend or guardian
    • an organization

Each CareTeam must support:

  • a status code

This resource conforms to USCDI V1 profile for CareTeam - refers to StructureDefinition US Core CareTeam.

CareTeam response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.

Must support elements, mandatory and optional search parameters

CareTeam must support these elements:

  • status
  • subject
  • participant
  • role
  • member

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 _include parameters: CareTeam:participant:PractitionerRole,CareTeam:participant:Practitioner,CareTeam:participant:Patient,CareTeam:participant:RelatedPerson
  • including support for composite OR search on status (e.g.status={system|}[code],{system|}[code],...)
GET [base]/CareTeam?patient={Type/}[id]&status=active

The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

CareTeam by Patient and Status

Get CareTeam by combination patient and status

METHOD GET

GET [base url]/CareTeam?patient={Type/}[id]&status=active`

PARAMS

  • [base url] - FHIR base url
  • {Type/} - optional parameter for reference type
  • [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'

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.

EXAMPLES:

curl --location --request GET 'https://demo.kodjin.com/fhir/CareTeam?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&status=active' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'