US Core Implementation Guide
4.1.0 - STU4 Ballot

This page is part of the US Core (v4.1.0: STU5 Ballot 1) 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

Resource Profile: US Core CareTeam Profile

Defining URL:http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam
Version:4.1.0
Name:USCoreCareTeam
Title:US Core CareTeam Profile
Status:Active as of 6/26/20
Definition:

Defines constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve a patient's Care Team.

Publisher:HL7 International - Cross-Group Projects
Copyright:

Used by permission of HL7 International, all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/core/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:

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition]) 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:

  1. a patient
  2. a participant role for each careteam members
  3. names of careteam members which can be:
    • a practitioner or practitioner type (doctor, nurse, therapist)*
    • the patient
    • a relative or friend or guardian
    • an organization

*See the next section for how practitioner members are represented in this Profile.

Each Condition must support:

  1. a status code

Profile specific implementation guidance:

In order to access care team member’s names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:

  1. US Core Practitioner Profile
  2. US Core PractitionerRole Profile
  3. US Core Patient Profile
  4. US Core RelatedPerson Profile
  • Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references (and _include search parameters), but SHALL support at least one of them.
  • The client application SHALL support all four profile references.
  • Because the US Core PractitionerRole Profile supplies the provider’s location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile. An example of how to access the practitioner name and identifier is shown in the quick start section below.
  • Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... status S0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates whether the team is current , represents future intentions or is now a historical record.

... subject S1..1Reference(US Core Patient Profile)Who care team is for
... participant S1..*BackboneElementMembers of the team
.... role S1..1CodeableConceptType of involvement
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.

.... member S1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile S | US Core PractitionerRole Profile S | US Core CareTeam Profile | US Core Related Person S)Who is involved

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this team
... status ?!SΣ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates whether the team is current , represents future intentions or is now a historical record.

... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(US Core Patient Profile)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ1..1CodeableConceptType of involvement
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


.... member SΣ1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile S | US Core PractitionerRole Profile S | US Core CareTeam Profile | US Core Related Person S)Who is involved
.... onBehalfOf Σ0..1Reference(Organization)Organization of the practitioner
.... period 0..1PeriodTime period of participant
... reasonCode 0..*CodeableConceptWhy 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..*ContactPointA contact detail for the care team (that applies to all members)
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... status ?!Σ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates whether the team is current , represents future intentions or is now a historical record.

... subject Σ1..1Reference(US Core Patient Profile)Who care team is for
... participant I1..*BackboneElementMembers of the team
.... role Σ1..1CodeableConceptType of involvement
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


.... member Σ1..1Reference(US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core Related Person)Who is involved

doco Documentation for this format

Differential View

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... status S0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates whether the team is current , represents future intentions or is now a historical record.

... subject S1..1Reference(US Core Patient Profile)Who care team is for
... participant S1..*BackboneElementMembers of the team
.... role S1..1CodeableConceptType of involvement
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.

.... member S1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile S | US Core PractitionerRole Profile S | US Core CareTeam Profile | US Core Related Person S)Who is involved

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this team
... status ?!SΣ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates whether the team is current , represents future intentions or is now a historical record.

... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(US Core Patient Profile)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ1..1CodeableConceptType of involvement
Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.


.... member SΣ1..1Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile S | US Core PractitionerRole Profile S | US Core CareTeam Profile | US Core Related Person S)Who is involved
.... onBehalfOf Σ0..1Reference(Organization)Organization of the practitioner
.... period 0..1PeriodTime period of participant
... reasonCode 0..*CodeableConceptWhy 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..*ContactPointA contact detail for the care team (that applies to all members)
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
CareTeam.languagepreferredCommonLanguages
Max Binding: AllLanguages
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleextensibleCare Team Member Function
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • The syntax used to describe the interactions is described here.
  • 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:

  1. SHALL support searching using the combination of the patient and status search parameters:
    • including optional support for these _include parameters: CareTeam:participant:PractitionerRole,CareTeam:participant:Practitioner,CareTeam:participant:Patient,CareTeam:participant:RelatedPerson
    • including optional support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/CareTeam?patient={Type/}[id]&status=active

    Example:

    1. GET [base]/CareTeam?patient=1137192&status=active
    2. GET [base]/CareTeam?patient=1137192&status=active&_include=CareTeam:participant:RelatedPerson&_include=CareTeam:participant:Patient&_include=CareTeam:participant:Practitioner&_include=CareTeam:participant:PractitionerRole

    Implementation Notes: Fetches a bundle of all CareTeam resources for the specified patient and status =active and may include CareTeam Patient, RelatedPerson and Practitioner and PractitionerRole participants.
    To get Practitioner name and identifier using PractitionerRole:
    1) Search for the careteam PractitionerRole: GET [base]/CareTeam?patient=[id]&status=active&_include=CareTeam:participant:PractitionerRole 2) using the FHIR _id from the PractitionerRole.practitioner element resource, fetch the Practitioner resources using GET [base]/Practitioner?_id=[id] (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and role search parameters:
    • including optional support for these _include parameters: CareTeam:participant:PractitionerRole,CareTeam:participant:Practitioner,CareTeam:participant:Patient,CareTeam:participant:RelatedPerson
    • including optional support for OR search on role (e.g.role={system|}[code],{system|}[code],...)

    GET [base]/CareTeam?patient={Type/}[id]&role={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/CareTeam?patient=1137192&role=http://snomed.info/sct|17561000

    Implementation Notes: Fetches a bundle of all CareTeam resources for the specified patient and participant role (how to search by reference and how to search by token)