Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vSTU3.Model.Resource.CarePlan

class HS.FHIR.DTL.vSTU3.Model.Resource.CarePlan extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = CarePlan;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = CarePlan;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property activity as list of HS.FHIR.DTL.vSTU3.Model.Element.CarePlan.activity (XMLNAME = "activity", XMLPROJECTION = "ELEMENT");
BackboneElement

Action to occur as part of plan.

Property methods: activityBuildValueArray(), activityCollectionToDisplay(), activityCollectionToOdbc(), activityDisplayToCollection(), activityGet(), activityGetObject(), activityGetObjectId(), activityGetSwizzled(), activityIsValid(), activityOdbcToCollection(), activitySet(), activitySetObject(), activitySetObjectId()
property addresses as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");
Reference

Health issues this plan addresses.

Condition

Property methods: addressesBuildValueArray(), addressesCollectionToDisplay(), addressesCollectionToOdbc(), addressesDisplayToCollection(), addressesGet(), addressesGetObject(), addressesGetObjectId(), addressesGetSwizzled(), addressesIsValid(), addressesOdbcToCollection(), addressesSet(), addressesSetObject(), addressesSetObjectId()
property author as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Reference

Who is responsible for contents of the plan.

Patient | Practitioner | RelatedPerson | Organization | CareTeam

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Fulfills care plan.

CarePlan

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property careTeam as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "careTeam", XMLPROJECTION = "ELEMENT");
Reference

Who's involved in plan?

CareTeam

Property methods: careTeamBuildValueArray(), careTeamCollectionToDisplay(), careTeamCollectionToOdbc(), careTeamDisplayToCollection(), careTeamGet(), careTeamGetObject(), careTeamGetObjectId(), careTeamGetSwizzled(), careTeamIsValid(), careTeamOdbcToCollection(), careTeamSet(), careTeamSetObject(), careTeamSetObjectId()
property category as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of plan.

any FHIR3 code may be used; care-plan-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Created in context of.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Reference

Protocol or definition.

PlanDefinition | Questionnaire

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Summary of nature of plan.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property goal as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "goal", XMLPROJECTION = "ELEMENT");
Reference

Desired outcome of plan.

Goal

Property methods: goalBuildValueArray(), goalCollectionToDisplay(), goalCollectionToOdbc(), goalDisplayToCollection(), goalGet(), goalGetObject(), goalGetObjectId(), goalGetSwizzled(), goalIsValid(), goalOdbcToCollection(), goalSet(), goalSetObject(), goalSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Ids for this plan.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

care-plan-intent is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend care-plan-intent and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments about the plan.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of referenced CarePlan.

CarePlan

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Time period plan covers.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property replaces as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
Reference

CarePlan replaced by this CarePlan.

CarePlan

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | suspended | completed | entered-in-error | cancelled | unknown

care-plan-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend care-plan-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who care plan is for.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInfo as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
Reference

Information considered as part of plan.

Any FHIR3 Resource may be indicated by this Reference

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Human-friendly name for the CarePlan.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab