care teams

Create Care Team

post

/organizations/{organizationId}/fhir/4/CareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a CareTeam resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		proposed\|active\|suspended\|inactive\|entered-in-error	Indicates the current state of the care team.
category	array(CodeableConcept)		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.
name	string		A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subject	Reference		Identifies the patient or group whose intended care is handled by the team.
encounter	Reference		The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
period	Period		Indicates when the team did (or is intended to) come into effect and end.
participant	array(CareTeam_Participant)		Identifies all people and organizations who are expected to be involved in the care team.
reasonCode	array(CodeableConcept)		Describes why the care team exists.
reasonReference	array(Reference)		Condition(s) that this care team addresses.
managingOrganization	array(Reference)		The organization responsible for the care team.
telecom	array(ContactPoint)		A central contact detail for the care team (that applies to all members).
note	array(Annotation)		Comments made about the CareTeam.

Response

201 400 401 404

Patch Care Team

patch

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a CareTeam resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		proposed\|active\|suspended\|inactive\|entered-in-error	Indicates the current state of the care team.
category	array(CodeableConcept)		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.
name	string		A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subject	Reference		Identifies the patient or group whose intended care is handled by the team.
encounter	Reference		The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
period	Period		Indicates when the team did (or is intended to) come into effect and end.
participant	array(CareTeam_Participant)		Identifies all people and organizations who are expected to be involved in the care team.
reasonCode	array(CodeableConcept)		Describes why the care team exists.
reasonReference	array(Reference)		Condition(s) that this care team addresses.
managingOrganization	array(Reference)		The organization responsible for the care team.
telecom	array(ContactPoint)		A central contact detail for the care team (that applies to all members).
note	array(Annotation)		Comments made about the CareTeam.

Response

200 201 400 401 404 409

Read Care Team

get

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Care Team

get

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Care Team

get

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Care Team

delete

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Care Team

get

/organizations/{organizationId}/fhir/4/CareTeam

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Care Team

get

/organizations/{organizationId}/fhir/4/CareTeam/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Care Team

post

/organizations/{organizationId}/fhir/4/CareTeam/_search

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a CareTeam resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		proposed\|active\|suspended\|inactive\|entered-in-error	Indicates the current state of the care team.
category	array(CodeableConcept)		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.
name	string		A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subject	Reference		Identifies the patient or group whose intended care is handled by the team.
encounter	Reference		The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
period	Period		Indicates when the team did (or is intended to) come into effect and end.
participant	array(CareTeam_Participant)		Identifies all people and organizations who are expected to be involved in the care team.
reasonCode	array(CodeableConcept)		Describes why the care team exists.
reasonReference	array(Reference)		Condition(s) that this care team addresses.
managingOrganization	array(Reference)		The organization responsible for the care team.
telecom	array(ContactPoint)		A central contact detail for the care team (that applies to all members).
note	array(Annotation)		Comments made about the CareTeam.

Response

200 401 404

Update Care Team

put

/organizations/{organizationId}/fhir/4/CareTeam/{resourceId}

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a CareTeam resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		proposed\|active\|suspended\|inactive\|entered-in-error	Indicates the current state of the care team.
category	array(CodeableConcept)		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.
name	string		A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subject	Reference		Identifies the patient or group whose intended care is handled by the team.
encounter	Reference		The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
period	Period		Indicates when the team did (or is intended to) come into effect and end.
participant	array(CareTeam_Participant)		Identifies all people and organizations who are expected to be involved in the care team.
reasonCode	array(CodeableConcept)		Describes why the care team exists.
reasonReference	array(Reference)		Condition(s) that this care team addresses.
managingOrganization	array(Reference)		The organization responsible for the care team.
telecom	array(ContactPoint)		A central contact detail for the care team (that applies to all members).
note	array(Annotation)		Comments made about the CareTeam.

Response

200 201 400 401 404 409