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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CareTeam resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
statusproposed|active|suspended|inactive|entered-in-errorIndicates the current state of the care team.
categoryarray(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.
namestringA label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subjectReferenceIdentifies the patient or group whose intended care is handled by the team.
encounterReferenceThe Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the team did (or is intended to) come into effect and end.
participantarray(CareTeam_Participant)Identifies all people and organizations who are expected to be involved in the care team.
reasonCodearray(CodeableConcept)Describes why the care team exists.
reasonReferencearray(Reference)Condition(s) that this care team addresses.
managingOrganizationarray(Reference)The organization responsible for the care team.
telecomarray(ContactPoint)A central contact detail for the care team (that applies to all members).
notearray(Annotation)Comments made about the CareTeam.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CareTeam resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
statusproposed|active|suspended|inactive|entered-in-errorIndicates the current state of the care team.
categoryarray(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.
namestringA label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subjectReferenceIdentifies the patient or group whose intended care is handled by the team.
encounterReferenceThe Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the team did (or is intended to) come into effect and end.
participantarray(CareTeam_Participant)Identifies all people and organizations who are expected to be involved in the care team.
reasonCodearray(CodeableConcept)Describes why the care team exists.
reasonReferencearray(Reference)Condition(s) that this care team addresses.
managingOrganizationarray(Reference)The organization responsible for the care team.
telecomarray(ContactPoint)A central contact detail for the care team (that applies to all members).
notearray(Annotation)Comments made about the CareTeam.

Response

Read Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
encounterstring
identifierstring
participantstring
patientstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Care Team

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
encounterstring
identifierstring
participantstring
patientstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CareTeam resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
statusproposed|active|suspended|inactive|entered-in-errorIndicates the current state of the care team.
categoryarray(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.
namestringA label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subjectReferenceIdentifies the patient or group whose intended care is handled by the team.
encounterReferenceThe Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the team did (or is intended to) come into effect and end.
participantarray(CareTeam_Participant)Identifies all people and organizations who are expected to be involved in the care team.
reasonCodearray(CodeableConcept)Describes why the care team exists.
reasonReferencearray(Reference)Condition(s) that this care team addresses.
managingOrganizationarray(Reference)The organization responsible for the care team.
telecomarray(ContactPoint)A central contact detail for the care team (that applies to all members).
notearray(Annotation)Comments made about the CareTeam.

Response

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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CareTeam resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
statusproposed|active|suspended|inactive|entered-in-errorIndicates the current state of the care team.
categoryarray(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.
namestringA label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
subjectReferenceIdentifies the patient or group whose intended care is handled by the team.
encounterReferenceThe Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the team did (or is intended to) come into effect and end.
participantarray(CareTeam_Participant)Identifies all people and organizations who are expected to be involved in the care team.
reasonCodearray(CodeableConcept)Describes why the care team exists.
reasonReferencearray(Reference)Condition(s) that this care team addresses.
managingOrganizationarray(Reference)The organization responsible for the care team.
telecomarray(ContactPoint)A central contact detail for the care team (that applies to all members).
notearray(Annotation)Comments made about the CareTeam.

Response