US Core Implementation Guide (Release 1)

This page is part of the US Core (v1.0.0: STU1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

1.0 - 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 Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These 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 status code
  2. a patient
  3. a participant role for each careteam members
  4. names of careteam members which can be:
    • a practitioner (doctor, nurse, therapist)
    • the patient
    • a relative or friend or guardian
    • an organization

Profile specific implementation guidance:

  • none

Examples

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam

This profile builds on CareTeam.

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.

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

Complete Summary of the Mandatory Requirements

  1. One status in CareTeam.status
  2. One reference to a patient in CareTeam.subject
  3. One participant role for each careteam member in CareTeam.participant.rolewhich which has:
  4. Careteam members in CareTeam.participant.member
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*US Core CareTeam Profile
... id Σ0..1idLogical 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: Common Languages (extensible)
... text I0..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Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required)
... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example)
... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(US Core Patient Profile)Who care team is for
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter or episode associated with CareTeam
... period Σ0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role SΣ1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (extensible)
.... member SΣ1..1Reference(US Core Patient Profile), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization)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: SNOMED CT Clinical Findings (example)
... reasonReference 0..*Reference(Condition)Why the care team exists
... managingOrganization Σ0..*Reference(Organization)Organization responsible for the care team
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. One status in CareTeam.status
  2. One reference to a patient in CareTeam.subject
  3. One participant role for each careteam member in CareTeam.participant.rolewhich which has:
  4. Careteam members in CareTeam.participant.member

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*US Core CareTeam Profile
... id Σ0..1idLogical 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: Common Languages (extensible)
... text I0..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Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required)
... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example)
... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(US Core Patient Profile)Who care team is for
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter or episode associated with CareTeam
... period Σ0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role SΣ1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (extensible)
.... member SΣ1..1Reference(US Core Patient Profile), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization)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: SNOMED CT Clinical Findings (example)
... reasonReference 0..*Reference(Condition)Why the care team exists
... managingOrganization Σ0..*Reference(Organization)Organization responsible for the care team
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

GET/CareTeam?patient=[id]&status=active

Example: GET [base]/CareTeam?patient=1137192&status=active

Support: Mandatory to support search by patient and status.

Implementation Notes: Search for all current care team members for a patient. Fetches a bundle of all current CareTeam resource(s) and the participants referenced by the CareTeam resource(s) for the specified patient. (how to search by reference), (how to search by token).