CareTeam

Top  Previous  Next

People and organizations who plan to participate in the coordination and delivery of care for a patient.

 

Response Description

Sample Response

{

  "resourceType": "CareTeam",

  "id": "DEV-DEV-11913-0014789",

  "meta": {

     "lastUpdated": "2022-10-26T12:00:00-04:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian (DEV-DEV-11913)</td></tr><tr><td>Encounter:</td><td>DEV-DEV-11913-0014789</td></tr><tr><td>Description:</td><td>MRI L/Knee</td></tr><tr><td>Date:</td><td>10/24/22</td></tr><tr><td>Physician (occupation):</td><td>Steven Aspen, M. D.</td></tr></tbody></table></div>"

  },

  "status": "inactive",

  "name": "For appointment on 10/24/2022, MRI L/Knee",

  "subject": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian (DEV-DEV-11913)"

  },

  "period": {

     "start": "2022-10-24",

     "end": "2022-10-24"

  },

  "encounter": {

     "reference": "Encounter/DEV-DEV-11913-0014789",

     "display": "10/24/2022 at 7:00 am, MRI L/Knee with provider 117 at location OF1"

  },

  "participant": [

     {

        "role": [

           {

              "coding": [

                 {

                    "system": "http://snomed.info/sct",

                    "code": "309343006",

                    "display": "Physician (occupation)"

                 }

              ],

              "text": "Physician (occupation)"

           }

        ],

        "member": {

           "reference": "Practitioner/117",

           "display": "Steven Aspen, M. D."

        }

     }

  ]

}

 

 

CareTeam.id

 

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality

0..1

Type

string

Comment

The only time that a resource does not have an ID is when it is being submitted to the server using a create operation.

 

 

CareTeam.meta

 

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality

0..1

Type

Meta

 

 

CareTeam.text

 

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality

0..1

Type

Narrative

Comment

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

 

 

CareTeam.status

 

Indicates the current state of the care team.

Cardinality

0..1

Type

code: CareTeamStatus

Comment

active if encounter is today, otherwise always inactive.

 

 

CareTeam.name

 

A label for human use intended to distinguish like teams.

Cardinality

0..1

Type

string

Comment

Gives encounter date and description

 

 

CareTeam.subject

 

Identifies the patient or group whose intended care is handled by the team.

Cardinality

0..1

Type

Reference(Patient | Group)

Requirements

Allows the team to care for a group (e.g. marriage) therapy. Allows for an organization to designate a team such as the PICC line team.

 

 

CareTeam.subject.reference

 

The ID of the patient who received care.

Cardinality

0..1

Type

string

Comment

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[ID]" then it should be assumed that the reference is to a FHIR RESTful server.

 

 

CareTeam.subject.display

 

The name of the patient who received care.

Cardinality

0..1

Type

string

Comment

This is generally not the same as the CareTeam.text. The purpose is to identify what's being referenced, not to fully describe it.

 

 

CareTeam.period

 

Indicates when the team did (or is intended to) come into effect and end.

Cardinality

0..1

Type

Period

Requirements

Allows tracking what team(s) are in effect at a particular time.

 

 

CareTeam.period.start

 

The start of the period. The boundary is inclusive.

Cardinality

0..1

Type

dateTime

Comment

If the low element is missing, the meaning is that the low boundary is not known.

 

 

CareTeam.period.end

 

The end of the period.

Cardinality

0..1

Type

dateTime

Comment

If the end of the period is missing, it means that the period is ongoing.

 

 

CareTeam.encounter

 

The ID of the Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

Cardinality

0..1

Type

Reference(Encounter)


This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

 

 

CareTeam.participant

 

Identifies all people and organizations involved in the care team.

Cardinality

0..*

Type

BackboneElement

 

 

CareTeam.participant.role

 

Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.

Cardinality

0..*

Type

CodeableConcept. Participant Roles

Comment

Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.

 

 

CareTeam.participant.role.text

 

A human-readable description of the participant's role.

Cardinality

0..1

Type

Narrative

Comment

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

 

 

CareTeam.participant.member

 

The specific person or organization who is participating in the care team.

Cardinality

0..1

Type

Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam)

Comment

Patient only needs to be listed if they have a role other than "subject of care".

 

 

CareTeam.participant.member.reference

 

A reference to a location at which the resource is found.

Cardinality

0..1

Type

string

Comment

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[ID]" then it should be assumed that the reference is to a FHIR RESTful server.

 

 

CareTeam.participant.member.display

 

The name of the care team member in plain text.

Cardinality

0..1

Type

string

Comment

This is generally not the same as the CareTeam.text. The purpose is to identify what's being referenced, not to fully describe it.

 


 

Search

 

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

 

 

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/CareTeam?{query string}

 

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/CareTeam/{resource id}

 

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/CareTeam/_search

Set the Content-Type header to application/x-www-urlencoded

The body of the request is a similar query string used in the GET type of request detailed above.

 

 

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

 

 

Supported Search Parameters

 

_id

Corresponds to

CareTeam.id

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CareTeam?_id=dev-dev-11913

 

Returns all CareTeam resources for the 11913 account in the dev practice.

 

patient + status

Corresponds to

CareTeam.subject and CareTeam.status

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CareTeam?patient=Patient/dev-dev-11913&status=active

 

Collect active (appointment is today) care team members for account 11913 in the dev practice.

 

patient + status + _revInclude:Provenance:target

Corresponds to

CareTeam.subject and CareTeam.status

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CareTeam?patient=Patient/dev-dev-11913&status=active&_revInclude=Provenance:target

 

Collect active  care team members for account 11913 in the dev practice, and include the Provenance record for each care team member

 

encounter

Corresponds to

CareTeam.encounter

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/CareTeam?encounter=Encounter/DEV-DEV-11913-0014789

 

Returns the CareTeam members for the encounter with an ID of DEV-DEV-11913-0014789