CareTeam - FHIR Resource (r4)
This CareTeam Resource uses the FHIR API standard for access and structure.
Validate an CareTeam FHIR Resource (r4)
CareTeam Attributes
AttributeField is listTypeDescription
Description: External Ids for this team
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "12345"
}
]Learn more about the (CareTeam) identifier FHIR attribute
Description: proposed | active | suspended | inactive | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (CareTeam) status FHIR attribute
Description: Type of team
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LA27976-2",
"display": "Encounter-focused care team"
}
]
}
]Learn more about the (CareTeam) category FHIR attribute
Description: Name of the team, such as crisis assessment team
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "Peter James Charlmers Care Plan for Inpatient Encounter"Learn more about the (CareTeam) name FHIR attribute
Description: Who care team is for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}Learn more about the (CareTeam) subject FHIR attribute
Description: Encounter created as part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (CareTeam) encounter FHIR attribute
Description: Time period team covers
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"end": "2013-01-01"
}Learn more about the (CareTeam) period FHIR attribute
Description: C? Members of the team
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": [
{
"role": [
{
"text": "responsiblePerson"
}
],
"member": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}
},
{
"role": [
{
"text": "adviser"
}
],
"member": {
"reference": "#pr1",
"display": "Dorothy Dietition"
},
"onBehalfOf": {
"reference": "Organization/f001"
},
"period": {
"end": "2013-01-01"
}
}
]Learn more about the (CareTeam) participant FHIR attribute
Description: Why the care team exists
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (CareTeam) reasonCode FHIR attribute
Description: Why the care team exists
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (CareTeam) reasonReference FHIR attribute
Description: Organization responsible for the care team
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": [
{
"reference": "Organization/f001"
}
]Learn more about the (CareTeam) managingOrganization FHIR attribute
Description: A contact detail for the care team (that applies to all members)
FHIR Version: r4
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": Learn more about the (CareTeam) telecom FHIR attribute
Description: Comments made about the CareTeam
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (CareTeam) note FHIR attribute
CareTeam Example
{
"resourceType": "CareTeam",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Team</div>"
},
"contained": [
{
"resourceType": "Practitioner",
"id": "pr1",
"name": [
{
"family": "Dietician",
"given": [
"Dorothy"
]
}
]
}
],
"identifier": [
{
"value": "12345"
}
],
"status": "active",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LA27976-2",
"display": "Encounter-focused care team"
}
]
}
],
"name": "Peter James Charlmers Care Plan for Inpatient Encounter",
"subject": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
},
"encounter": {
"reference": "Encounter/example"
},
"period": {
"end": "2013-01-01"
},
"participant": [
{
"role": [
{
"text": "responsiblePerson"
}
],
"member": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}
},
{
"role": [
{
"text": "adviser"
}
],
"member": {
"reference": "#pr1",
"display": "Dorothy Dietition"
},
"onBehalfOf": {
"reference": "Organization/f001"
},
"period": {
"end": "2013-01-01"
}
}
],
"managingOrganization": [
{
"reference": "Organization/f001"
}
]
}CareTeam Structure
{
"resourceType" : "CareTeam",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Ids for this team
"status" : "<code>", // proposed | active | suspended | inactive | entered-in-error
"category" : [{ CodeableConcept }], // Type of team
"name" : "<string>", // Name of the team, such as crisis assessment team
"subject" : { Reference(Patient|Group) }, // Who care team is for
"encounter" : { Reference(Encounter) }, // Encounter created as part of
"period" : { Period }, // Time period team covers
"participant" : [{ // C? Members of the team
"role" : [{ CodeableConcept }], // Type of involvement
"member" : { Reference(Practitioner|PractitionerRole|RelatedPerson|Patient|
Organization|CareTeam) }, // Who is involved
"onBehalfOf" : { Reference(Organization) }, // Organization of the practitioner
"period" : { Period } // Time period of participant
}],
"reasonCode" : [{ CodeableConcept }], // Why the care team exists
"reasonReference" : [{ Reference(Condition) }], // Why the care team exists
"managingOrganization" : [{ Reference(Organization) }], // Organization responsible for the care team
"telecom" : [{ ContactPoint }], // A contact detail for the care team (that applies to all members)
"note" : [{ Annotation }] // Comments made about the CareTeam
}
CareTeam Search Parameters
The following search parameters can be used to query CareTeam resources. Just submit them like so:
https://api.1up.health/fhir/r4/CareTeam?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
category | text | category |
date | date | period |
encounter | reference | encounter |
identifier | text | identifier |
participant | reference | participant.member |
patient | reference | subject.where |
status | text | status |
subject | reference | subject |
