CareTeam read

get/CareTeam/{id}

Page View

This resource details the individual(s), team(s), or organization(s) who participate in or implement care for a patient or group. This could include non-providers like family members or guardians or transient team members for extended care. Typically, this resource type is referenced within a CarePlan or Encounter resource to define the context for a treatment plan or patient visit.

You can review or retrieve care team information.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

This interaction allows you to review a specific CareTeam resource with the details of a patient’s or group’s care team.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/CareTeam/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
CareTeam identifier

Response fields and example

Example Care Team

json

1
{}

A profile on the CareTeam resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: CareTeam
subject
required, object
Identifies the patient or group whose intended care is handled by the team.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
participant
required, Array of object
Identifies all people and organizations who are expected to be involved in the care team.
- role
  required, Array of object
  Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
- member
  required, object
  The specific person or organization who is participating/expected to participate in the care team.
  
  Must be a resource of type Practitioner.
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
- period
  object
  Indicates when the specific member or organization did (or is intended to) come into effect and end.
  start
  string
  The start of the period. The boundary is inclusive.
  end
  string
  The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
status
string
Indicates the current state of the care team.
Possible Values: proposed, active, suspended, inactive, entered-in-error
category
Array of object
Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
name
string
A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
encounter
object
The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
managingOrganization
Array of object
The organization responsible for the care team.

Must be a resource of type Organization.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.