National Healthcare Directory Exchange
1.0.0-ballot - ballot

National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions

## Resource Profile: NatlDirExCareTeam - Detailed Descriptions

Active as of 2022-12-08

Definitions for the NatlDirEx-CareTeam resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. CareTeam

Guidance on how to interpret the contents of this table can be found here.

1. CareTeam
Definition | The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
Control | 0..*
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. CareTeam.extension:alias
SliceName | alias
Definition | Alternate names by which the team is also known
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(CareteamAlias) (Extension Type: string)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. CareTeam.extension:location
SliceName | location
Definition | An extension to indicate the location(s) at which the care team operates
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(LocationReference) (Extension Type: Reference(NatlDirEndpointQryLocation))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. CareTeam.extension:service
SliceName | service
Definition | An extension to describe the healthcare services provided by the care team
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(HealthcareServiceReference) (Extension Type: Reference)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. CareTeam.extension:endpoint
SliceName | endpoint
Definition | An extensions indicating endpoints for the care team
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(EndpointReference) (Extension Type: Reference)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
7. CareTeam.extension:restriction
SliceName | restriction
Definition | Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(UsageRestriction) (Extension Type: Reference)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
8. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. CareTeam.identifier
Definition | Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
Requirements | Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. CareTeam.identifier.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 10..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CareTeam.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
11. CareTeam.identifier.extension:status
SliceName | status
Definition | Describes the status of an identifier
Control | 1..1
Type | Extension(IdentifierStatus) (Extension Type: code)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. CareTeam.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. CareTeam.status
Definition | Indicates the current state of the care team.
Control | 10..1
Binding | The codes SHALL be taken from CareTeamStatus Indicates the status of the care team.
Type | code
Is Modifier | true
Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. 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.
Control | 10..*
Binding | For example codes, see CareTeamCategory Indicates the type of care team.
Type | CodeableConcept
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. CareTeam.name
Definition | A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
Control | 0..1
Type | string
Must Support | true
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 its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly.).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. CareTeam.subject
Definition | Identifies the patient or group whose intended care is handled by the team.
Control | 0..01
Type | Reference(Patient|Group)
Requirements | Allows the team to care for a group (e.g. marriage) therapy. Allows for an organization to designate a team such as the PICC line team.
Alternate Names | patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. CareTeam.encounter
Definition | The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
Control | 0..01
Type | Reference(Encounter)
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. CareTeam.reasonCode
Definition | Describes why the care team exists.
Control | 0..0*
Binding | For example codes, see SNOMEDCTClinicalFindings Indicates the reason for the care team.
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. CareTeam.reasonReference
Definition | Condition(s) that this care team addresses.
Control | 0..0*
Type | Reference(Condition)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. CareTeam.managingOrganization
Definition | The organization responsible for the care team.
Control | 0..1*
Type | Reference(NatlDirEndpointQryOrganization|Organization)
Requirements | Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. CareTeam
Definition | The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
Control | 0..*
2. CareTeam.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
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.
3. CareTeam.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. CareTeam.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. CareTeam.text
Definition | A human-readable narrative that contains a summary of the resource and can 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.
Control | 0..1
Type | Narrative
Alternate Names | narrative, 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 information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.
Control | 0..*
Type | Resource
Alternate Names | inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. CareTeam.extension
Definition | An Extension
Control | 0..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CareTeam.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. CareTeam.extension:alias
SliceName | alias
Definition | Alternate names by which the team is also known
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(CareteamAlias) (Extension Type: string)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. CareTeam.extension:location
SliceName | location
Definition | An extension to indicate the location(s) at which the care team operates
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(LocationReference) (Extension Type: Reference(NatlDirEndpointQryLocation))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. CareTeam.extension:service
SliceName | service
Definition | An extension to describe the healthcare services provided by the care team
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(HealthcareServiceReference) (Extension Type: Reference)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. CareTeam.extension:endpoint
SliceName | endpoint
Definition | An extensions indicating endpoints for the care team
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(EndpointReference) (Extension Type: Reference)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
13. CareTeam.extension:restriction
SliceName | restriction
Definition | Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(UsageRestriction) (Extension Type: Reference)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
14. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. CareTeam.identifier
Definition | Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
Requirements | Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. CareTeam.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
17. CareTeam.identifier.extension
Definition | An Extension
Control | 1..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CareTeam.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
18. CareTeam.identifier.extension:status
SliceName | status
Definition | Describes the status of an identifier
Control | 1..1
Type | Extension(IdentifierStatus) (Extension Type: code)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. CareTeam.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. CareTeam.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. CareTeam.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 0..1
Type | uri
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. CareTeam.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 0..1
Type | string
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. CareTeam.identifier.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. CareTeam.identifier.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(NatlDirEndpointQryOrganization)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. CareTeam.status
Definition | Indicates the current state of the care team.
Control | 1..1
Binding | The codes SHALL be taken from CareTeamStatus Indicates the status of the care team
Type | code
Is Modifier | true
Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. 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.
Control | 1..*
Binding | For example codes, see CareTeamCategory Indicates the type of care team
Type | CodeableConcept
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. CareTeam.name
Definition | A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
Control | 0..1
Type | string
Must Support | true
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 its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly.).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. CareTeam.subject
Definition | Identifies the patient or group whose intended care is handled by the team.
Control | 0..0
Type | Reference(Patient|Group)
Requirements | Allows the team to care for a group (e.g. marriage) therapy. Allows for an organization to designate a team such as the PICC line team.
Alternate Names | patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. CareTeam.encounter
Definition | The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
Control | 0..0
Type | Reference(Encounter)
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. CareTeam.period
Definition | Indicates when the team did (or is intended to) come into effect and end.
Control | 0..1
Type | Period
Requirements | Allows tracking what team(s) are in effect at a particular time.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. CareTeam.participant
Definition | Identifies all people and organizations who are expected to be involved in the care team.
Control | 0..* This element is affected by the following invariants: ctm-1
Type | BackboneElement
Invariants | Defined on this element ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner (: onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
33. CareTeam.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
35. 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.
Control | 0..*
Binding | For example codes, see ParticipantRoles Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc
Type | CodeableConcept
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. CareTeam.participant.member
Definition | The role associated with the specific person or organization who is participating/expected to participate in the care team.
Control | 0..1
Type | Reference(NatlDirEndpointQryCareTeam|NatlDirEndpointQryPractitionerRole|NatlDirEndpointQryOrganization)
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. CareTeam.participant.onBehalfOf
Definition | The organization of the practitioner.
Control | 0..0
Type | Reference(Organization)
Requirements | Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. CareTeam.participant.period
Definition | Indicates when the specific member or organization did (or is intended to) come into effect and end.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. CareTeam.reasonCode
Definition | Describes why the care team exists.
Control | 0..0
Binding | For example codes, see SNOMEDCTClinicalFindings Indicates the reason for the care team
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. CareTeam.reasonReference
Definition | Condition(s) that this care team addresses.
Control | 0..0
Type | Reference(Condition)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. CareTeam.managingOrganization
Definition | The organization responsible for the care team.
Control | 0..1
Type | Reference(NatlDirEndpointQryOrganization)
Requirements | Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. CareTeam.telecom
Definition | A central contact detail for the care team (that applies to all members).
Control | 0..*
Type | ContactPoint
Comments | The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. CareTeam.telecom.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
44. CareTeam.telecom.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CareTeam.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
45. CareTeam.telecom.extension:contactpoint-availabletime
SliceName | contactpoint-availabletime
Definition | An extension representing the days and times a contact point is available
Control | 0..*
Type | Extension(ContactPointAvailableTime) (Complex Extension)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
46. CareTeam.telecom.extension:via-intermediary
SliceName | via-intermediary
Definition | A reference to an alternative point of contact (NatlDirEndpointQry-PractitionerRole, NatlDirEndpointQry-Organization, NatlDirEndpointQry-OrganizationAffiliation, or NatlDirEndpointQry-Location) for this organization
Control | 0..*
Type | Extension(ViaIntermediary) (Extension Type: Reference(NatlDirEndpointQryPractitionerRole|NatlDirEndpointQryOrganizationAffiliation|NatlDirEndpointQryLocation|NatlDirEndpointQryOrganization))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. CareTeam.telecom.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Control | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem Telecommunications form for contact point
Type | code
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. CareTeam.telecom.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Control | 0..1
Type | string
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. CareTeam.telecom.use
Definition | Identifies the purpose for the contact point.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse Use of contact point
Type | code
Is Modifier | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. CareTeam.telecom.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Control | 0..1
Type | positiveInt
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. CareTeam.telecom.period
Definition | Time period when the contact point was/is in use.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. CareTeam.note
Definition | Comments made about the CareTeam.
Control | 0..*
Type | Annotation
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. CareTeam.note.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
54. CareTeam.note.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on CareTeam.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
55. CareTeam.note.author[x]
Definition | The individual responsible for making the annotation.
Control | 0..1
Type | Choice of: Reference(NatlDirEndpointQryPractitioner), string
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | Organization is used when there's no need for specific attribution as to who made the comment.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. CareTeam.note.time
Definition | Indicates when this particular annotation was made.
Control | 0..1
Type | dateTime
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. CareTeam.note.text
Definition | The text of the annotation in markdown format.
Control | 1..1
Type | markdown
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))