Data Model Libraries
    Preparing search index...

    Class CarePlan

    CarePlan Class

    Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

    FHIR Specification

    • Short: Healthcare plan for patient or group
    • Definition: Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
    • FHIR Version: 4.3.0

    FHIR CarePlan

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? replaces? partOf? requestStatusEnum status requestIntentEnum intent category? title? description? subject encounter? period? created? author? contributor? careTeam? addresses? supportingInfo? goal? activity? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getReplaces setReplaces addReplaces hasReplaces getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getCategory setCategory addCategory hasCategory getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getPeriod setPeriod hasPeriod getCreatedElement setCreatedElement hasCreatedElement getCreated setCreated hasCreated getAuthor setAuthor hasAuthor getContributor setContributor addContributor hasContributor getCareTeam setCareTeam addCareTeam hasCareTeam getAddresses setAddresses addAddresses hasAddresses getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getGoal setGoal addGoal hasGoal getActivity setActivity addActivity hasActivity getNote setNote addNote hasNote fhirType isEmpty isRequiredFieldsEmpty 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 isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initInstantiatesCanonical initInstantiatesUri initBasedOn initReplaces initPartOf initCategory initContributor initCareTeam initAddresses initSupportingInfo initGoal initActivity initNote

    Constructors

    Properties

    identifier?: Identifier[]

    CarePlan.identifier Element

    FHIR Specification

    • Short: External Ids for this plan
    • Definition: Business identifiers assigned to this care plan 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 plan 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
    instantiatesCanonical?: CanonicalType[]

    CarePlan.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType[]

    CarePlan.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    CarePlan.basedOn Element

    FHIR Specification

    • Short: Fulfills CarePlan
    • Definition: A care plan that is fulfilled in whole or in part by this care plan.
    • Requirements: Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    replaces?: Reference[]

    CarePlan.replaces Element

    FHIR Specification

    • Short: CarePlan replaced by this CarePlan
    • Definition: Completed or terminated care plan whose function is taken by this new care plan.
    • Comment: The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.
    • Requirements: Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    partOf?: Reference[]

    CarePlan.partOf Element

    FHIR Specification

    • Short: Part of referenced CarePlan
    • Definition: A larger care plan of which this particular care plan is a component or step.
    • Comment: Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    requestStatusEnum: RequestStatusEnum

    FHIR CodeSystem: RequestStatus

    RequestStatusEnum

    status: null | EnumCodeType

    CarePlan.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
    • Comment: The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.
    • Requirements: Allows clinicians to determine whether the plan is actionable or not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled 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: RequestStatusEnum

    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    RequestIntentEnum

    intent: null | EnumCodeType

    CarePlan.intent Element

    FHIR Specification

    • Short: proposal | plan | order | option
    • Definition: Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
    • Comment: This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
    • Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request"
    • isSummary: true

    CodeSystem Enumeration: RequestIntentEnum

    category?: CodeableConcept[]

    CarePlan.category Element

    FHIR Specification

    • Short: Type of plan
    • Definition: Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
    • Comment: There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.
    • Requirements: Used for filtering what plan(s) are retrieved and displayed to different types of users.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    title?: StringType

    CarePlan.title Element

    FHIR Specification

    • Short: Human-friendly name for the care plan
    • Definition: Human-friendly name for the care plan.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    CarePlan.description Element

    FHIR Specification

    • Short: Summary of nature of plan
    • Definition: A description of the scope and nature of the plan.
    • Requirements: Provides more detail than conveyed by category.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    CarePlan.subject Element

    FHIR Specification

    encounter?: Reference

    CarePlan.encounter Element

    FHIR Specification

    • Short: Encounter created as part of
    • Definition: The Encounter during which this CarePlan 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. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    CarePlan.period Element

    FHIR Specification

    • Short: Time period plan covers
    • Definition: Indicates when the plan did (or is intended to) come into effect and end.
    • Comment: Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).
    • Requirements: Allows tracking what plan(s) are in effect at a particular time.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    created?: DateTimeType

    CarePlan.created Element

    FHIR Specification

    • Short: Date record was first recorded
    • Definition: Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    author?: Reference

    CarePlan.author Element

    FHIR Specification

    contributor?: Reference[]

    CarePlan.contributor Element

    FHIR Specification

    careTeam?: Reference[]

    CarePlan.careTeam Element

    FHIR Specification

    • Short: Who's involved in plan?
    • Definition: Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
    • Requirements: Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    addresses?: Reference[]

    CarePlan.addresses Element

    FHIR Specification

    • Short: Health issues this plan addresses
    • Definition: Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
    • Comment: When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.
    • Requirements: Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    supportingInfo?: Reference[]

    CarePlan.supportingInfo Element

    FHIR Specification

    • Short: Information considered as part of plan
    • Definition: Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
    • Comment: Use "concern" to identify specific conditions addressed by the care plan.
    • Requirements: Identifies barriers and other considerations associated with the care plan.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    goal?: Reference[]

    CarePlan.goal Element

    FHIR Specification

    • Short: Desired outcome of plan
    • Definition: Describes the intended objective(s) of carrying out the care plan.
    • Comment: Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.
    • Requirements: Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    activity?: CarePlanActivityComponent[]

    CarePlan.activity Element

    FHIR Specification

    • Short: Action to occur as part of plan
    • Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
    • Requirements: Allows systems to prompt for performance of planned activities, and validate plans against best practice.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    CarePlan.note Element

    FHIR Specification

    • Short: Comments about the plan
    • Definition: General notes about the care plan not covered elsewhere.
    • Requirements: Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CarePlan

      • OptionaloptSourceField: string

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

      Returns undefined | CarePlan

      CarePlan data model or undefined for CarePlan

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Author object value to the author property.

      Parameters

      • value: undefined | Reference

        the author object value

      Returns this

      this

      @ReferenceTargets('CarePlan.author', ['Patient','Practitioner','PractitionerRole','Device','RelatedPerson','Organization','CareTeam',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the contributor array value

      Returns this

      this

      @ReferenceTargets('CarePlan.contributor', ['Patient','Practitioner','PractitionerRole','Device','RelatedPerson','Organization','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the contributor array property.

      Parameters

      • value: undefined | Reference

        the contributor value

      Returns this

      this

      @ReferenceTargets('CarePlan.contributor', ['Patient','Practitioner','PractitionerRole','Device','RelatedPerson','Organization','CareTeam',])

      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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetReplacessetReplacesaddReplaceshasReplacesgetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetCategorysetCategoryaddCategoryhasCategorygetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetPeriodsetPeriodhasPeriodgetCreatedElementsetCreatedElementhasCreatedElementgetCreatedsetCreatedhasCreatedgetAuthorsetAuthorhasAuthorgetContributorsetContributoraddContributorhasContributorgetCareTeamsetCareTeamaddCareTeamhasCareTeamgetAddressessetAddressesaddAddresseshasAddressesgetSupportingInfosetSupportingInfoaddSupportingInfohasSupportingInfogetGoalsetGoaladdGoalhasGoalgetActivitysetActivityaddActivityhasActivitygetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitBasedOninitReplacesinitPartOfinitCategoryinitContributorinitCareTeaminitAddressesinitSupportingInfoinitGoalinitActivityinitNote