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.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-us-core-careteam Profile.

CareTeam(USCoreCareTeam)
Definition

The US Core CareTeam Profile is based upon the core FHIR CareTeam Resource and created to meet the 2015 Edition Common Clinical Data Set 'Care team member(s)' requirements.

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained))
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)))
CareTeam.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

CareTeam.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
CareTeam.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

CareTeam.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

CareTeam.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

CareTeam.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

CareTeam.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CareTeam.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CareTeam.identifier
Definition

This records identifiers associated with this care team that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
CareTeam.status
Definition

Indicates whether the care team is currently active, suspended, inactive, or entered in error.

Control1..1
BindingIndicates whether the team is current , represents future intentions or is now a historical record.
The codes SHALL be taken from CareTeamStatus
TypeCodeableConcept
Is Modifiertrue
Must Supporttrue
CareTeam.category
Definition

Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

Control0..*
TypeCodeableConcept
Requirements

Used for filtering what teams(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axis of categorization and one team may serve multiple purposes.

CareTeam.name
Definition

A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.

Control0..1
Typestring
Comments

The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. "Red trauma team"), but it's primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly . ).

CareTeam.subject
Definition

Identifies the patient or group whose intended care is handled by the team.

Control1..1
TypeReference(US Core Patient Profile)
Must Supporttrue
Requirements

Allows the team to care for a group (e.g. marriage) therapy.

CareTeam.period
Definition

Indicates when the team did (or is intended to) come into effect and end.

Control0..1
TypePeriod
Requirements

Allows tracking what team(s) are in effect at a particular time.

CareTeam.participant
Definition

Identifies all people and organizations who are expected to be involved in the care team.

Control1..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CareTeam.participant.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CareTeam.participant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CareTeam.participant.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CareTeam.participant.role
Definition

Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.

Control1..1
BindingIndicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
The codes SHALL be taken from CareTeam Provider Roles
TypeCodeableConcept
Must Supporttrue
Comments

Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.

CareTeam.participant.member
Definition

The specific person or organization who is participating/expected to participate in the care team.

Control1..1
TypeChoice of: Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Organization)
Must Supporttrue
Comments

Patient only needs to be listed if they have a role other than "subject of care". Member is optional because some participants may be known only by their role, particularly in draft plans.

CareTeam.participant.period
Definition

Indicates when the specific member or organization did (or is intended to) come into effect and end.

Control0..1
TypePeriod
CareTeam.managingOrganization
Definition

The organization responsible for the care team.

Control0..*
TypeReference(Organization)
Requirements

Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.