CareTeam

Overview
Terminology Bindings
Search
Retrieve by id

Overview

The R4 CareTeam resource represents a patient’s care team members. 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).

The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
- US Core CareTeam Profile

The following fields are returned if valued:

Terminology Bindings

CareTeam.status

Description

Indicates the current state of the care team.

Details: Request Status
System: http://hl7.org/fhir/request-status

CareTeam.category

Description

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.

Details: Request Category
System: http://hl7.org/fhir/us/core/CodeSystem/careteam-category

CareTeam.participant.role

Description

Role of participant in care team.

Details: Participant Role
System: http://hl7.org/fhir/r4/valueset-participant-role.html

Search

Search for CareTeams that meet supplied query parameters:

GET /CareTeam?:parameters

Implementation Notes

The CareTeam search returns the active Care Teams only.

Authorization Types

Provider | Patient | System

Parameters

Name	Required?	Type	Description
`_id`	Required if `patient` or `encounter` is not present	`token`	The logical resource id associated with the resource.
`patient`	Required if `_id` or `encounter` is not present	`reference`	Who care team is for. Example: `patient=12345`
`encounter`	Required if `_id` or `patient` is not present	`reference`	Who care team is for. Example: `encounter=98765`
`category`	N	`token`	The scope of care team being searched for. Examples: `category=longitudinal`
`status`	N	`token`	Indicates the status of the care team
`_revinclude`	No	`token`	Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target

Notes:

The _id parameter
- This is required if patient or encounter are not provided.
The patient parameter
- This is required when _id or encounter is not provided.
- This can be combined with status as per US Core guidelines.
- This can be combined with the category parameter.
The encounter parameter
- This is required when _id or patient is not provided.
- This cannot be combined with category or status.
The category parameter
- Only supports the codes longitudinal and encounter.
- Can only be used with the patient parameter.
- The longitudinal and encounter codes are defined by the CareTeam category system
The _revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
The _revinclude parameter may be provided with the _id/patient parameter. Example: _id=LIFETIME_PROVIDER-4169494-0-4105597-0-0-0&_revinclude=Provenance:target
When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the user/Provenance.read scope. Currently patient/Provenance.read is not supported and hence _revinclude cannot be utilised for patient persona.

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=119078440&category=encounter

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "8c34294c-ba46-492d-bb8e-9937db0ddd5b",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=119078440&category=encounter"
    },
    {
      "relation": "next",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=119078440"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/CARE_TEAM-119078440-34768489-17490349-4048128-0-22554767",
      "resource": {
        "resourceType": "CareTeam",
        "id": "CARE_TEAM-119078440-34768489-17490349-4048128-0-22554767",
        "meta": {
          "versionId": "1584980008",
          "lastUpdated": "2020-03-23T16:13:28Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: FHIR, FIRE3</p><p><b>Care Team Name</b>: Psychology;Blue Team</p><p><b>Status</b>: Active</p><p><b>Category</b>: Encounter-focused care team</p><p><b>Encounter</b>: 34768489</p><p><b>Participant</b>:</p><ul><li>Name: Dickey, Bo; Role: Psychologist (occupation)</li></ul></div>"
        },
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LA27976-2",
                "display": "Encounter-focused care team"
              }
            ],
            "text": "Encounter-focused care team"
          }
        ],
        "name": "Psychology;Blue Team",
        "subject": {
          "reference": "Patient/119078440",
          "display": "FHIR, FIRE3"
        },
        "encounter": {
          "reference": "Encounter/34768489"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "59944000",
                    "display": "Psychologist (occupation)"
                  }
                ],
                "text": "Psychologist (occupation)"
              }
            ],
            "member": {
              "reference": "Practitioner/17490349",
              "display": "Dickey, Bo"
            },
            "period": {
              "start": "2020-06-22T10:05:08Z",
              "end": "2100-12-31T00:00:00Z"
            }
          }
        ]
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example with RevInclude

Authorization Types

Provider | System

Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?_id=LIFETIME_PROVIDER-4169494-0-4105597-0-0-0&_revinclude=Provenance:target

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "0bcf7619-a5c4-4363-b234-3803f7cb0d44",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=4169494"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/LIFETIME_PROVIDER-4169494-0-4105597-0-0-0",
      "resource": {
        "resourceType": "CareTeam",
        "id": "LIFETIME_PROVIDER-4169494-0-4105597-0-0-0",
        "meta": {
          "versionId": "1606412761",
          "lastUpdated": "2020-11-26T17:46:01Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: SHEPARD, JACK</p><p><b>Status</b>: Active</p><p><b>Category</b>: Longitudinal-focused care team</p><p><b>Participant</b>:</p><ul><li>Name: ONEPLAN, ONEPLAN; Role: Family medicine specialist (occupation)</li></ul></div>"
        },
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LA28865-6",
                "display": "Longitudinal-focused care team"
              }
            ],
            "text": "Longitudinal-focused care team"
          }
        ],
        "subject": {
          "reference": "Patient/4169494",
          "display": "SHEPARD, JACK"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "62247001",
                    "display": "Family medicine specialist (occupation)"
                  }
                ],
                "text": "Family medicine specialist (occupation)"
              }
            ],
            "member": {
              "reference": "Practitioner/4105597",
              "display": "ONEPLAN, ONEPLAN"
            },
            "period": {
              "start": "2020-06-22T10:05:08Z",
              "end": "2100-12-31T00:00:00Z"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.hcncrn-00a5d6eb-c567-42f7-be07-53804cece075",
      "resource": {
        "resourceType": "Provenance",
        "id": "INT.cteam-LIFETIME_PROVIDER-4169494-0-4105597-0-0-0",
        "meta": {
          "versionId": "00a5d6eb-c567-42f7-be07-53804cece075",
          "lastUpdated": "2020-07-06T19:36:23Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>CareTeam/LIFETIME_PROVIDER-4169494-0-4105597-0-0-0</li></ul><p><b>RecordedSpence, Open Platform IA, Stephen</b>: Jul  6, 2020  7:36 P.M. UTC</p><p><b>Agents</b>:</p><dl><dt></dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>"
        },
        "target": [
          {
            "reference": "CareTeam/LIFETIME_PROVIDER-4169494-0-4105597-0-0-0"
          }
        ],
        "recorded": "2020-07-06T19:36:23Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Practitioner/12724064",
              "display": "Spence, Open Platform IA, Stephen"
            }
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=4169494

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "0bcf7619-a5c4-4363-b234-3803f7cb0d44",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam?patient=4169494"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/LIFETIME_PROVIDER-4169494-0-3038500-0-0-0",
      "resource": {
        "resourceType": "CareTeam",
        "id": "CARE_TEAM-119078440-34768489-17490349-4048128-0-22554767",
        "meta": {
          "versionId": "1584980008",
          "lastUpdated": "2020-03-23T16:13:28Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: FHIR, FIRE3</p><p><b>Care Team Name</b>: Psychology;Blue Team</p><p><b>Status</b>: Active</p><p><b>Category</b>: Encounter-focused care team</p><p><b>Encounter</b>: 34768489</p><p><b>Participant</b>:</p><ul><li>Name: Dickey, Bo; Role: Psychologist (occupation)</li></ul></div>"
        },
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LA27976-2",
                "display": "Encounter-focused care team"
              }
            ],
            "text": "Encounter-focused care team"
          }
        ],
        "name": "Psychology;Blue Team",
        "subject": {
          "reference": "Patient/119078440",
          "display": "FHIR, FIRE3"
        },
        "encounter": {
          "reference": "Encounter/34768489"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "59944000",
                    "display": "Psychologist (occupation)"
                  }
                ],
                "text": "Psychologist (occupation)"
              }
            ],
            "member": {
              "reference": "Practitioner/17490349",
              "display": "Dickey, Bo"
            },
            "period": {
              "start": "2020-06-22T10:05:08Z",
              "end": "2100-12-31T00:00:00Z"
            }
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/LIFETIME_PROVIDER-4169494-0-4105597-0-0-0",
      "resource": {
        "resourceType": "CareTeam",
        "id": "LIFETIME_PROVIDER-4169494-0-4105597-0-0-0",
        "meta": {
          "versionId": "1606412761",
          "lastUpdated": "2020-11-26T17:46:01Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: SHEPARD, JACK</p><p><b>Status</b>: Active</p><p><b>Category</b>: Longitudinal-focused care team</p><p><b>Participant</b>:</p><ul><li>Name: ONEPLAN, ONEPLAN; Role: Family medicine specialist (occupation)</li></ul></div>"
        },
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LA28865-6",
                "display": "Longitudinal-focused care team"
              }
            ],
            "text": "Longitudinal-focused care team"
          }
        ],
        "subject": {
          "reference": "Patient/4169494",
          "display": "SHEPARD, JACK"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "62247001",
                    "display": "Family medicine specialist (occupation)"
                  }
                ],
                "text": "Family medicine specialist (occupation)"
              }
            ],
            "member": {
              "reference": "Practitioner/4105597",
              "display": "ONEPLAN, ONEPLAN"
            },
            "period": {
              "start": "2020-06-22T10:05:08Z",
              "end": "2100-12-31T00:00:00Z"
            }
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/LIFETIME_PROVIDER-4169494-0-4090846-0-0-0",
      "resource": {
        "resourceType": "CareTeam",
        "id": "LIFETIME_PROVIDER-4169494-0-4090846-0-0-0",
        "meta": {
          "versionId": "1606743013",
          "lastUpdated": "2020-11-30T13:30:13Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: SHEPARD, JACK</p><p><b>Status</b>: Active</p><p><b>Category</b>: Longitudinal-focused care team</p><p><b>Participant</b>:</p><ul><li>Name: P, Ashoka; Role: Clinical oncologist (occupation)</li></ul></div>"
        },
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LA28865-6",
                "display": "Longitudinal-focused care team"
              }
            ],
            "text": "Longitudinal-focused care team"
          }
        ],
        "subject": {
          "reference": "Patient/4169494",
          "display": "SHEPARD, JACK"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "309295000",
                    "display": "Clinical oncologist (occupation)"
                  }
                ],
                "text": "Clinical oncologist (occupation)"
              }
            ],
            "member": {
              "reference": "Practitioner/4090846",
              "display": "P, Ashoka"
            },
            "period": {
              "start": "2020-06-22T10:05:08Z",
              "end": "2100-12-31T00:00:00Z"
            }
          }
        ]
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual CareTeam by its id:

GET /CareTeam/:id

Implementation Notes

The CareTeam read returns the active Care Teams only.

Authorization Types

Provider | Patient | System

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/CARE_TEAM-119078440-34768489-17490349-4048128-0-22554767

Response

Status: 200 OK

{
  "resourceType": "CareTeam",
  "id": "CARE_TEAM-119078440-34768489-17490349-4048128-0-22554767",
  "meta": {
    "versionId": "1584980008",
    "lastUpdated": "2020-03-23T16:13:28Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: FHIR, FIRE3</p><p><b>Care Team Name</b>: Psychology;Blue Team</p><p><b>Status</b>: Active</p><p><b>Category</b>: Encounter-focused care team</p><p><b>Encounter</b>: 34768489</p><p><b>Participant</b>:</p><ul><li>Name: Dickey, Bo; Role: Psychologist (occupation)</li></ul></div>"
  },
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "LA27976-2",
          "display": "Encounter-focused care team"
        }
      ],
      "text": "Encounter-focused care team"
    }
  ],
  "name": "Psychology;Blue Team",
  "subject": {
    "reference": "Patient/119078440",
    "display": "FHIR, FIRE3"
  },
  "encounter": {
    "reference": "Encounter/34768489"
  },
  "participant": [
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "59944000",
              "display": "Psychologist (occupation)"
            }
          ],
          "text": "Psychologist (occupation)"
        }
      ],
      "member": {
        "reference": "Practitioner/17490349",
        "display": "Dickey, Bo"
      },
      "period": {
        "start": "2020-06-22T10:05:08Z",
        "end": "2100-12-31T00:00:00Z"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Patient Authorization Request

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/CareTeam/LIFETIME_PROVIDER-4169494-0-3038500-0-0-0

Response

Status: 200 OK

{
  "resourceType": "CareTeam",
  "id": "LIFETIME_PROVIDER-4169494-0-3038500-0-0-0",
  "meta": {
    "versionId": "1606410852",
    "lastUpdated": "2020-11-26T17:14:12Z"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Care Team</b></p><p><b>Patient</b>: SHEPARD, JACK</p><p><b>Status</b>: Active</p><p><b>Category</b>: Longitudinal-focused care team</p><p><b>Participant</b>:</p><ul><li>Name: BASE, TEST123; Role: Primary Care Physician</li></ul></div>"
  },
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "LA28865-6",
          "display": "Longitudinal-focused care team"
        }
      ],
      "text": "Longitudinal-focused care team"
    }
  ],
  "subject": {
    "reference": "Patient/4169494",
    "display": "SHEPARD, JACK"
  },
  "participant": [
    {
      "role": [
        {
          "text": "Primary Care Physician"
        }
      ],
      "member": {
        "reference": "Practitioner/3038500",
        "display": "BASE, TEST123"
      },
      "period": {
        "start": "2020-06-22T10:05:08Z",
        "end": "2100-12-31T00:00:00Z"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Millennium

CareTeam

Overview

Terminology Bindings

Search

Authorization Types

Parameters

Headers

Example

Request

Response

Example with RevInclude

Authorization Types

Request

Response

Patient Authorization Request

Response

Errors

Retrieve by id

Authorization Types

Headers

Example

Request

Response

Patient Authorization Request

Response

Errors

R4 Overview

Foundation

Base

Clinical

Financial

Specialized

Bulk Data