Home
API reference
FHIR® API
FHIR® resources
CareTeam
_search

CareTeam _search

post/CareTeam/_search
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.

_search

Query for the care plan team information from one organization.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.
  • patient

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/CareTeam/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'status=string'

Request Body Schema

  • patient
    Array of string

    Who has the care team?

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • status
    Array of string

    proposed | active | suspended | inactive | entered-in-error

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "CareTeam",
9
        "id": "RedoxCareTeamExample",
10
        "status": "active",
11
        "category": [
12
          {
13
            "coding": [
14
              {
15
                "code": "86744-0",
16
                "system": "http://loinc.org"
17
              }
18
            ],
19
            "text": "Care Team"
20
          }
21
        ],
22
        "name": "Example Care Team",
23
        "subject": {
24
          "reference": "Patient/RedoxPatientExampleTimothy"
25
        },
26
        "encounter": {
27
          "reference": "Encounter/RedoxEncounterExample"
28
        },
29
        "managingOrganization": [
30
          {
31
            "reference": "Organization/RedoxOrganizationManagingExample"
32
          }
33
        ],
34
        "participant": [
35
          {
36
            "member": {
37
              "reference": "Practitioner/RedoxPractitionerExamplePat"
38
            },
39
            "role": [
40
              {
41
                "coding": [
42
                  {
43
                    "code": "59058001",
44
                    "system": "http://snomed.info/sct"
45
                  }
46
                ],
47
                "text": "General Physician"
48
              }
49
            ],
50
            "period": {
51
              "start": "2010-01-01T12:00:00Z"
52
            }
53
          }
54
        ]
55
      },
56
      "search": {
57
        "mode": "match"
58
      }
59
    }
60
  ]
61
}

    Response to a CareTeam search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of CareTeam or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      Care teams responsible for a patient.

      • 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.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the CareTeam as matching the search parameters

        Value: match