This page is part of the US Core (v3.1.0: STU3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions
StructureDefinition-us-core-careteam
This profile sets minimum expectations for the CareTeam resource for identifying the Care Team members associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-CareTeam profile:
- Query for a Patient’s CareTeam
- Record or update a Patient’s CareTeam
Mandatory and Must Support Data Elements
The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each CareTeam must have:
- a patient
- a participant role for each careteam members
- names of careteam members which can be:
- a practitioner (doctor, nurse, therapist)
- the patient
- a relative or friend or guardian
- an organization
Each Condition must support:
- a status code
Profile specific implementation guidance:
- none
Examples
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam
Published on Mon Aug 26 00:00:00 AEST 2019 as active by the HL7 US Realm Steering Committee.
This profile builds on CareTeam
CareTeam
Summary of the Mandatory Requirements
- A Patient Reference in
CareTeam.subject
- One or more Participants in
CareTeam.participant
with the following constraints: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner- which must have a CodeableConcept value in
CareTeam.participant.role
with an extensible binding to US Core CareTeam Provider Roles - which must have a Member Reference value in
CareTeam.participant.member
- which must have a CodeableConcept value in
Summary of the Must Support Requirements
- A code in
CareTeam.status
with a required binding to CareTeamStatus
Summary of Constraints
- CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | I | 0..* | Planned participants in the coordination and delivery of care for a patient or group | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | External Ids for this team |
status | ?!SΣI | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
category | ΣI | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
name | ΣI | 0..1 | string | Name of the team, such as crisis assessment team |
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Who care team is for |
encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
period | ΣI | 0..1 | Period | Time period team covers |
participant | SI | 1..* | BackboneElement | Members of the team |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | SΣI | 1..1 | CodeableConcept | Type of involvement Binding: US Core CareTeam Provider Roles (extensible) |
member | SΣI | 1..1 | Reference(US Core Patient Profile | US Core Practitioner Profile | US Core Organization Profile | RelatedPerson) | Who is involved |
onBehalfOf | ΣI | 0..1 | Reference(Organization) | Organization of the practitioner |
period | I | 0..1 | Period | Time period of participant |
reasonCode | I | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example) |
reasonReference | I | 0..* | Reference(Condition) | Why the care team exists |
managingOrganization | ΣI | 0..* | Reference(Organization) | Organization responsible for the care team |
telecom | I | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
note | I | 0..* | Annotation | Comments made about the CareTeam |
Documentation for this format |
CareTeam
Summary of the Mandatory Requirements
- A Patient Reference in
CareTeam.subject
- One or more Participants in
CareTeam.participant
with the following constraints: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner- which must have a CodeableConcept value in
CareTeam.participant.role
with an extensible binding to US Core CareTeam Provider Roles - which must have a Member Reference value in
CareTeam.participant.member
- which must have a CodeableConcept value in
Summary of the Must Support Requirements
- A code in
CareTeam.status
with a required binding to CareTeamStatus
Summary of Constraints
- CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | I | 0..* | Planned participants in the coordination and delivery of care for a patient or group | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | External Ids for this team |
status | ?!SΣI | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required) |
category | ΣI | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example) |
name | ΣI | 0..1 | string | Name of the team, such as crisis assessment team |
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Who care team is for |
encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
period | ΣI | 0..1 | Period | Time period team covers |
participant | SI | 1..* | BackboneElement | Members of the team |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | SΣI | 1..1 | CodeableConcept | Type of involvement Binding: US Core CareTeam Provider Roles (extensible) |
member | SΣI | 1..1 | Reference(US Core Patient Profile | US Core Practitioner Profile | US Core Organization Profile | RelatedPerson) | Who is involved |
onBehalfOf | ΣI | 0..1 | Reference(Organization) | Organization of the practitioner |
period | I | 0..1 | Period | Time period of participant |
reasonCode | I | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example) |
reasonReference | I | 0..* | Reference(Condition) | Why the care team exists |
managingOrganization | ΣI | 0..* | Reference(Organization) | Organization responsible for the care team |
telecom | I | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
note | I | 0..* | Annotation | Comments made about the CareTeam |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
- See the General Guidance section for additional rules and expectations when a server requires status parameters.
- See the General Guidance section for additional guidance on searching for multiple patients.
Mandatory Search Parameters:
The following search parameters and search parameter combinations SHALL be supported.:
- SHALL support searching using the combination of the
patient
andstatus
search parameters:- including support for composite OR search on
status
(e.g.status={[system]}|[code],{[system]}|[code],...
)
GET [base]/CareTeam?patient=[reference]&status=active
Example:
- GET [base]/CareTeam?patient=1137192&status=active
Implementation Notes: Fetches a bundle of all CareTeam resources for the specified patient and status =
active
(how to search by reference and how to search by token) - including support for composite OR search on