Publish Box goes here
Resource Profile: Profile - Athena CareTeam
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | Version: 23.1.0 | |||
| Active as of 2022-03-01 | Computable Name: AthenaCareTeam | |||
Defines constraints and extensions on the careplan resource as supported by Athena Products.
This CareTeam profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
Overview
The CareTeam includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient..
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access CareTeam resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Source
The CareTeam resource is derived from CARETEAMMEMBER, PatientProfile, and DoctorFacility tables in athenaPractice and CARETEAMMEMBER, PERSON, and USR tables in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
- Examples for this Resource Profile: felecia cart Care Team
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareTeam
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
  id |
0..1 | id | Logical id of this artifact | |
  meta |
0..1 | Meta | Metadata about the resource | |
 lastUpdated |
1..1 | instant | When the resource version last changed | |
 Slices for profile |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
  profile:USCoreCareTeam |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam | |
 profile:AthenaCareTeam |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | |
 security |
0..1 | Coding | Security Labels applied to this resource | |
| identifier |
0..* | Identifier | External Ids for this team | |
| status |
S | 1..1 | code | proposed | active | suspended | inactive | entered-in-error |
| name |
0..1 | string | Name of the team, such as crisis assessment team | |
 subject |
S | 1..1 | Reference(Patient) | Who care team is for |
 Slices for participant |
S | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role |
  participant:RESPDOCTORID |
0..1 | BackboneElement | Members of the team | |
  role |
0..1 | CodeableConcept | Type of involvement | |
 member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:REFDOCTORID |
0..1 | BackboneElement | Members of the team | |
| role |
0..1 | CodeableConcept | Type of involvement | |
| member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:PRIMARYCAREPROVIDER |
0..1 | BackboneElement | Members of the team | |
| role |
0..1 | CodeableConcept | Type of involvement | |
| member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:RELATEDPERSONS |
0..1 | BackboneElement | Members of the team | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
| profile:USCoreCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam |
| profile:AthenaCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile |
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Ids for this team |
| status |
?!SΣ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. |
| name |
Σ | 0..1 | string | Name of the team, such as crisis assessment team |
| subject |
SΣ | 1..1 | Reference(Patient) | Who care team is for |
| Slices for participant |
SC | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
 participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| participant:RESPDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
| participant:REFDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
| participant:PRIMARYCAREPROVIDER |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
 participant:RELATEDPERSONS |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1from the FHIR Standard | |
| CareTeam.participant:RESPDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | |
| CareTeam.participant:REFDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | |
| CareTeam.participant:PRIMARYCAREPROVIDER.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
| profile:USCoreCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam | ||||
| profile:AthenaCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | ||||
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this team | ||||
| status |
?!SΣ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category |
Σ | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name |
Σ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Who care team is for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| period |
Σ | 0..1 | Period | Time period team covers | ||||
| Slices for participant |
SC | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:RESPDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:REFDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:PRIMARYCAREPROVIDER |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:RELATEDPERSONS |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| reasonCode |
0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team. | |||||
| reasonReference |
0..* | Reference(Condition) | Why the care team exists | |||||
| managingOrganization |
Σ | 0..* | Reference(Organization) | Organization responsible for the care team | ||||
| telecom |
0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| note |
0..* | Annotation | Comments made about the CareTeam | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| CareTeam.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1from the FHIR Standard | ||||
| CareTeam.category | example | CareTeamCategoryhttp://hl7.org/fhir/ValueSet/care-team-categoryfrom the FHIR Standard | ||||
| CareTeam.participant.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:RESPDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:REFDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:PRIMARYCAREPROVIDER.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:RELATEDPERSONS.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
This structure is derived from CareTeam
Summary
Mandatory: 3 elements(3 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of CareTeam.meta.profile
- The element 1 is sliced based on the value of CareTeam.participant
Differential View
This structure is derived from CareTeam
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for profile |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
| profile:USCoreCareTeam |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam | |
| profile:AthenaCareTeam |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | |
| security |
0..1 | Coding | Security Labels applied to this resource | |
| identifier |
0..* | Identifier | External Ids for this team | |
| status |
S | 1..1 | code | proposed | active | suspended | inactive | entered-in-error |
| name |
0..1 | string | Name of the team, such as crisis assessment team | |
| subject |
S | 1..1 | Reference(Patient) | Who care team is for |
| Slices for participant |
S | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role |
| participant:RESPDOCTORID |
0..1 | BackboneElement | Members of the team | |
| role |
0..1 | CodeableConcept | Type of involvement | |
| member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:REFDOCTORID |
0..1 | BackboneElement | Members of the team | |
| role |
0..1 | CodeableConcept | Type of involvement | |
| member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:PRIMARYCAREPROVIDER |
0..1 | BackboneElement | Members of the team | |
| role |
0..1 | CodeableConcept | Type of involvement | |
| member |
0..1 | Reference(Practitioner) | Who is involved | |
| participant:RELATEDPERSONS |
0..1 | BackboneElement | Members of the team | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed |
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
| profile:USCoreCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam |
| profile:AthenaCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile |
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | External Ids for this team |
| status |
?!SΣ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. |
| name |
Σ | 0..1 | string | Name of the team, such as crisis assessment team |
| subject |
SΣ | 1..1 | Reference(Patient) | Who care team is for |
| Slices for participant |
SC | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| participant:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| participant:RESPDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
| participant:REFDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
| participant:PRIMARYCAREPROVIDER |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved |
| participant:RELATEDPERSONS |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1from the FHIR Standard | |
| CareTeam.participant:RESPDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | |
| CareTeam.participant:REFDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | |
| CareTeam.participant:PRIMARYCAREPROVIDER.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CareTeam |
0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
| profile:USCoreCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam | ||||
| profile:AthenaCareTeam |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | ||||
| security |
Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this team | ||||
| status |
?!SΣ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category |
Σ | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name |
Σ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| subject |
SΣ | 1..1 | Reference(Patient) | Who care team is for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| period |
Σ | 0..1 | Period | Time period team covers | ||||
| Slices for participant |
SC | 1..* | BackboneElement | Members of the team Slice: Unordered, Open by value:role ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:RESPDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:REFDOCTORID |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:PRIMARYCAREPROVIDER |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| participant:RELATEDPERSONS |
C | 0..1 | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
| onBehalfOf |
Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period |
0..1 | Period | Time period of participant | |||||
| reasonCode |
0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team. | |||||
| reasonReference |
0..* | Reference(Condition) | Why the care team exists | |||||
| managingOrganization |
Σ | 0..* | Reference(Organization) | Organization responsible for the care team | ||||
| telecom |
0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| note |
0..* | Annotation | Comments made about the CareTeam | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| CareTeam.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| CareTeam.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1from the FHIR Standard | ||||
| CareTeam.category | example | CareTeamCategoryhttp://hl7.org/fhir/ValueSet/care-team-categoryfrom the FHIR Standard | ||||
| CareTeam.participant.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:RESPDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:REFDOCTORID.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:PRIMARYCAREPROVIDER.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.participant:RELATEDPERSONS.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| CareTeam.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
This structure is derived from CareTeam
Summary
Mandatory: 3 elements(3 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of CareTeam.meta.profile
- The element 1 is sliced based on the value of CareTeam.participant
Other representations of profile: CSV, Excel, Schematron
Notes:
Supported Interactions
Interactions supported by this resource are listed below.
Search Parameters
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for CareTeam resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/CareTeam?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
| Name | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results CareTeam resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token) | The ID of the resource |
| _lastUpdated (date) | |
| _lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token) | |
| patient (reference) | Who care team is for |
| identifier (token) | |
| status (token) | |
| subject (reference) | Who care plan is for |
| participant (reference) | Members of the team |
HTTP Response Codes
The following HTTP response codes are returned by this API call:
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |