Jump to

• Request
• Response

Get a care team by ID

get

/CareTeam/{id}

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves an individual care team by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : CareTeam

Type: object

Show Source

• category: array category
  The type of team.
• encounter: encounter
  The encounter during which this care team was created or to which the creation of this record is tightly associated.
• id(required): string
• identifier: array identifier
  The business identifiers assigned to this care team by the performer or other systems. The identifiers remain constant as the resource is updated and propagates from server to server.
• managingOrganization: array managingOrganization
  The organization responsible for the care team.
• name: string
  A label for human use intended to distinguish like teams.
• participant(required): array participant
  All people and organizations who are expected to be involved in the care team.
• period: period
  When the team took effect and ended or is intended to take effect and end.
• resourceType(required): string
  Allowed Values: [ "CareTeam" ]
• status: string
  The current state of the care team.
• subject(required): subject
  The patient or group whose intended care is handled by the team.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "subject",
        "participant"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "CareTeam"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"The business identifiers assigned to this care team by the performer or other systems. The identifiers remain constant as the resource is updated and propagates from server to server.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "status":{
            "type":"string",
            "description":"The current state of the care team."
        },
        "category":{
            "type":"array",
            "description":"The type of team.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "name":{
            "type":"string",
            "description":"A label for human use intended to distinguish like teams."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The patient or group whose intended care is handled by the team."
        },
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The encounter during which this care team was created or to which the creation of this record is tightly associated."
        },
        "period":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"When the team took effect and ended or is intended to take effect and end."
        },
        "participant":{
            "type":"array",
            "description":"All people and organizations who are expected to be involved in the care team.",
            "items":{
                "$ref":"#/components/schemas/CareTeamParticipant"
            }
        },
        "managingOrganization":{
            "type":"array",
            "description":"The organization responsible for the care team.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        }
    }
}

Nested Schema : category

Type: array

The type of team.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"The type of team.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : encounter

The encounter during which this care team was created or to which the creation of this record is tightly associated.

Match All

The encounter during which this care team was created or to which the creation of this record is tightly associated.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The encounter during which this care team was created or to which the creation of this record is tightly associated."
}

Nested Schema : identifier

Type: array

The business identifiers assigned to this care team by the performer or other systems. The identifiers remain constant as the resource is updated and propagates from server to server.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"The business identifiers assigned to this care team by the performer or other systems. The identifiers remain constant as the resource is updated and propagates from server to server.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : managingOrganization

Type: array

The organization responsible for the care team.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"The organization responsible for the care team.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : participant

Type: array

All people and organizations who are expected to be involved in the care team.

Show Source

• Array of: object CareTeamParticipant

{
    "type":"array",
    "description":"All people and organizations who are expected to be involved in the care team.",
    "items":{
        "$ref":"#/components/schemas/CareTeamParticipant"
    }
}

Nested Schema : period

When the team took effect and ended or is intended to take effect and end.

Match All

When the team took effect and ended or is intended to take effect and end.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"When the team took effect and ended or is intended to take effect and end."
}

Nested Schema : subject

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

Match All

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

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The patient or group whose intended care is handled by the team."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : CareTeamParticipant

Type: object

Show Source

• member(required): member
  The specific person or organization who is participating or expected to participate in the care team.
• onBehalfOf: onBehalfOf
  The organization of the practitioner.
• role(required): role
  The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on.

{
    "type":"object",
    "required":[
        "role",
        "member"
    ],
    "properties":{
        "role":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on."
        },
        "member":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The specific person or organization who is participating or expected to participate in the care team."
        },
        "onBehalfOf":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The organization of the practitioner."
        }
    }
}

Nested Schema : member

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

Match All

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

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The specific person or organization who is participating or expected to participate in the care team."
}

Nested Schema : onBehalfOf

The organization of the practitioner.

Match All

The organization of the practitioner.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The organization of the practitioner."
}

Nested Schema : role

The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on.

Match All

The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The specific responsibility of an individual in the care team, such as a primary care physician, trained social worker counselor, caregiver, and so on."
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top