Data Model Libraries
    Preparing search index...

    Class CareTeam

    CareTeam Class

    The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

    FHIR Specification

    • Short: Planned participants in the coordination and delivery of care for a patient or group
    • Definition: The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
    • FHIR Version: 4.0.1

    FHIR CareTeam

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? careTeamStatusEnum status? category? name? subject? encounter? period? participant? reasonCode? reasonReference? managingOrganization? telecom? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getNameElement setNameElement hasNameElement getName setName hasName getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getPeriod setPeriod hasPeriod getParticipant setParticipant addParticipant hasParticipant getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getManagingOrganization setManagingOrganization addManagingOrganization hasManagingOrganization getTelecom setTelecom addTelecom hasTelecom getNote setNote addNote hasNote fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initParticipant initReasonCode initReasonReference initManagingOrganization initTelecom initNote

    Constructors

    Properties

    identifier?: Identifier[]

    CareTeam.identifier Element

    FHIR Specification

    • Short: External Ids for this team
    • 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.
    • Comment: 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.
    • Requirements: Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    careTeamStatusEnum: CareTeamStatusEnum

    FHIR CodeSystem: CareTeamStatus

    CareTeamStatusEnum

    status?: EnumCodeType

    CareTeam.status Element

    FHIR Specification

    • Short: proposed | active | suspended | inactive | entered-in-error
    • Definition: Indicates the current state of the care team.
    • Comment: 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.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: CareTeamStatusEnum

    category?: CodeableConcept[]

    CareTeam.category Element

    FHIR Specification

    • Short: Type of team
    • 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.
    • Comment: There may be multiple axis of categorization and one team may serve multiple purposes.
    • Requirements: Used for filtering what teams(s) are retrieved and displayed to different types of users.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    CareTeam.name Element

    FHIR Specification

    • Short: Name of the team, such as crisis assessment team
    • Definition: A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
    • Comment: 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.).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference

    CareTeam.subject Element

    FHIR Specification

    • Short: Who care team is for
    • Definition: Identifies the patient or group whose intended care is handled by the team.
    • 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    CareTeam.encounter Element

    FHIR Specification

    • Short: Encounter created as part of
    • Definition: The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
    • Comment: 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    CareTeam.period Element

    FHIR Specification

    • Short: Time period team covers
    • Definition: Indicates when the team did (or is intended to) come into effect and end.
    • Requirements: Allows tracking what team(s) are in effect at a particular time.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    participant?: CareTeamParticipantComponent[]

    CareTeam.participant Element

    FHIR Specification

    • Short: Members of the team
    • Definition: Identifies all people and organizations who are expected to be involved in the care team.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonCode?: CodeableConcept[]

    CareTeam.reasonCode Element

    FHIR Specification

    • Short: Why the care team exists
    • Definition: Describes why the care team exists.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    CareTeam.reasonReference Element

    FHIR Specification

    managingOrganization?: Reference[]

    CareTeam.managingOrganization Element

    FHIR Specification

    • Short: Organization responsible for the care team
    • Definition: The organization responsible for the care team.
    • Requirements: Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    telecom?: ContactPoint[]

    CareTeam.telecom Element

    FHIR Specification

    • Short: A contact detail for the care team (that applies to all members)
    • Definition: A central contact detail for the care team (that applies to all members).
    • Comment: The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    CareTeam.note Element

    FHIR Specification

    • Short: Comments made about the CareTeam
    • Definition: Comments made about the CareTeam.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CareTeam JSON to instantiate the CareTeam data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CareTeam

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CareTeam

      Returns undefined | CareTeam

      CareTeam data model or undefined for CareTeam

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the managingOrganization property.

      Parameters

      • value: undefined | Reference[]

        the managingOrganization array value

      Returns this

      this

      @ReferenceTargets('CareTeam.managingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetPeriodsetPeriodhasPeriodgetParticipantsetParticipantaddParticipanthasParticipantgetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetManagingOrganizationsetManagingOrganizationaddManagingOrganizationhasManagingOrganizationgetTelecomsetTelecomaddTelecomhasTelecomgetNotesetNoteaddNotehasNotefhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitParticipantinitReasonCodeinitReasonReferenceinitManagingOrganizationinitTelecominitNote