Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Draft as of 2019-03-04 |
Definitions for the CareConnect-CareTeam-1 resource profile.
Guidance on how to interpret the contents of this table can be found here.
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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
3. 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
4. CareTeam.status | |
Definition | Indicates the current state of the care team. |
Control | 0..1 |
Binding | The codes SHALL be taken from CareTeamStatus Indicates the status of the care team. |
Type | code |
Is Modifier | true |
Summary | 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. |
5. CareTeam.subject | |
Definition | Identifies the patient or group whose intended care is handled by the team. |
Control | 0..1 |
Type | Reference(Group|CareConnectPatient1|Patient) |
Summary | true |
Requirements | Allows the team to care for a group (e.g. marriage) therapy. |
Alternate Names | patient |
6. CareTeam.context | |
Definition | The encounter or episode of care that establishes the context for this care team. |
Control | 0..1 |
Type | Reference(CareConnect-EpisodeOfCare-1|CareConnect-Encounter-1|Encounter|EpisodeOfCare) |
Summary | true |
Alternate Names | encounter |
7. CareTeam.reasonReference | |
Definition | Condition(s) that this care team addresses. |
Control | 0..* |
Type | Reference(CareConnect-Condition-1|Condition) |
8. CareTeam.managingOrganization | |
Definition | The organization responsible for the care team. |
Control | 0..* |
Type | Reference(CareConnect-Organization-1|Organization) |
Summary | true |
Requirements | Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan. |
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 | ||||
Summary | true | ||||
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 may not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
5. CareTeam.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
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). | ||||
6. 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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-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 in formation is added later. | ||||
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. | ||||
8. 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. | ||||
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. | ||||
9. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
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. | ||||
10. 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
11. 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. | ||||
12. CareTeam.identifier.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. | ||||
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. | ||||
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:
| ||||
13. 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 | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
14. 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 | ||||
Summary | true | ||||
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. | ||||
15. 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 | ||||
Summary | true | ||||
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. | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
16. 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 | ||||
Summary | true | ||||
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. | ||||
Example | General:123456 | ||||
17. CareTeam.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
18. CareTeam.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
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. | ||||
19. CareTeam.status | |||||
Definition | Indicates the current state of the care team. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from CareTeamStatus Indicates the status of the care team | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | 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. | ||||
20. 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 | 0..* | ||||
Binding | For example codes, see CareTeamCategory Indicates the type of care team | ||||
Type | CodeableConcept | ||||
Summary | 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. | ||||
21. 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 | ||||
Summary | 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 . ). | ||||
22. CareTeam.subject | |||||
Definition | Identifies the patient or group whose intended care is handled by the team. | ||||
Control | 0..1 | ||||
Type | Reference(Group|CareConnectPatient1) | ||||
Summary | true | ||||
Requirements | Allows the team to care for a group (e.g. marriage) therapy. | ||||
Alternate Names | patient | ||||
23. CareTeam.context | |||||
Definition | The encounter or episode of care that establishes the context for this care team. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-EpisodeOfCare-1|CareConnect-Encounter-1) | ||||
Summary | true | ||||
Alternate Names | encounter | ||||
24. CareTeam.period | |||||
Definition | Indicates when the team did (or is intended to) come into effect and end. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
Requirements | Allows tracking what team(s) are in effect at a particular time. | ||||
25. 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() is Practitioner)) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
26. 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. | ||||
27. 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. | ||||
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. | ||||
28. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
29. 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..1 | ||||
Binding | For example codes, see Participant Roles Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
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. | ||||
30. CareTeam.participant.member | |||||
Definition | The specific person or organization who is participating/expected to participate in the care team. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1|CareConnectPatient1|CareConnect-Practitioner-1|CareConnect-RelatedPerson-1|CareConnect-CareTeam-1) | ||||
Summary | true | ||||
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. | ||||
31. CareTeam.participant.onBehalfOf | |||||
Definition | The organization of the practitioner. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
Requirements | Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of. | ||||
32. 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 | ||||
33. CareTeam.reasonCode | |||||
Definition | Describes why the care team exists. | ||||
Control | 0..* | ||||
Binding | For example codes, see SNOMED CT Clinical Findings Indicates the reason for the care team | ||||
Type | CodeableConcept | ||||
34. CareTeam.reasonReference | |||||
Definition | Condition(s) that this care team addresses. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Condition-1) | ||||
35. CareTeam.managingOrganization | |||||
Definition | The organization responsible for the care team. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
Requirements | Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan. | ||||
36. CareTeam.note | |||||
Definition | Comments made about the CareTeam. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
37. 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. | ||||
38. CareTeam.note.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. | ||||
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. | ||||
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:
| ||||
39. CareTeam.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Choice of: string, Reference(CareConnectPatient1|CareConnect-Practitioner-1|CareConnect-RelatedPerson-1) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
40. CareTeam.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | true | ||||
41. CareTeam.note.text | |||||
Definition | The text of the annotation. | ||||
Control | 1..1 | ||||
Type | string |