US-Core CI Build

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

D.4.1 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

D.4.1.1 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 Health Level Seven International (FHIR-Infrastructure).

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.role
  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 ?!S1..1CodeableConceptactive | suspended | inactive | entered in error
Binding: CareTeamStatus (required)
... category ∑0..*CodeableConceptType of team
... name ∑0..1stringName of the team, such as crisis assessment team
... subject S1..1Reference(US Core Patient Profile)Who care team is for
... 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 S1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (required)
.... member S1..1Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization ∑0..*Reference(Organization)Organization responsible for the care team

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.role
  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 ?!S1..1CodeableConceptactive | suspended | inactive | entered in error
Binding: CareTeamStatus (required)
... category ∑0..*CodeableConceptType of team
... name ∑0..1stringName of the team, such as crisis assessment team
... subject S1..1Reference(US Core Patient Profile)Who care team is for
... 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 S1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (required)
.... member S1..1Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization ∑0..*Reference(Organization)Organization responsible for the care team

doco Documentation for this format

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

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Argonaut Search Criteria for StructureDefinition-us-core-careteam

Clients

  • A client is able to connect to a server and fetch all current care team members for a patient using GET[base]/CarePlan?patient=[id]&category=careteam&status=active

Servers

  • A server is capable of returning a patient’s current care team members using GET[base]/CarePlan?patient=[id]&category=careteam&status=active

  • A server has ensured that every API request includes a valid Authorization token, supplied via:Authorization: Bearer {server-specific-token-here}
  • A server has rejected any unauthorized requests by returning an HTTP 401 Unauthorized response code.

GET/CarePlan?patient=[id]&category=careteam&status=active

Support: Mandatory to support search by patient, category and status.

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

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan

Clients

  • A client has connected to a server and fetched all of a patient’s Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan.

  • A client has connected to a server and fetched all of a patient’s Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&date=[date].

  • A client SHOULD be capable of connecting to a server and fetching all of a patient’s active Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan&status=active.
  • A client SHOULD be capable of connecting to a server and fetching all of a patient’s active Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date].

Servers

  • A server is capable of returning all of a patient’s Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan.

  • A server is capable of returning a patient’s Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&date=[date].

  • A server SHOULD be capable returning all of a patient’s active Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan&status=active.

  • A server SHOULD be capable returning a patient’s active Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date].

  • A server has ensured that every API request includes a valid Authorization token, supplied via:Authorization: Bearer {server-specific-token-here}
  • A server has rejected any unauthorized requests by returning an HTTP 401 Unauthorized response code.

GET /CarePlan?patient=[id]&category=assess-plan

Support: Mandatory to support search by patient.

Implementation Notes: Search for all patient assessments and plans of treatment for a patient. Fetches a bundle of all CarePlan resources for the specified patient (how to search by reference) and (how to search by token).

.

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan

GET /CarePlan?patient=[id]&category=assess-plan&date=[date]

Support: Mandatory to support search by date

Implementation Notes: Search for all assessment and plan of treatment for a patient within a time period. Fetches a bundle of all CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date).

.

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan&date=ge2015-01-14

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan&date=ge2015-01-14&date=le2016-01-14

GET /CarePlan?patient=[id]&category=assess-plan&status=active

Support: SHOULD support search by patient and status = ‘active’.

Implementation Notes: SHOULD support search by reference and status. (how to search by reference), (how to search by token).

.

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&status=active

GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date]

Support: SHOULD support search by patient and status = ‘active’ and date.

Implementation Notes: Search for all active assessment and plan of treatment for a patient within a time period. Fetches a bundle of all active (careplan = “active”) CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date). .

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan&datatus=active&date=ge2015-01-14