Skip to main content


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

Healthcare plan for patient or group.

Property Inventory


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 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.


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

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.vDSTU2.Model.Base.Reference (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");

Health issues this plan addresses.


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

Who is responsible for contents of the plan.

Patient | Practitioner | RelatedPerson | Organization

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

Type of plan.

any FHIR2 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.vDSTU2.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Created in context of.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Summary of nature of plan.

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

Desired outcome of plan.


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

External Ids for this plan.

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

When last updated.

Property methods: modifiedDisplayToLogical(), modifiedGet(), modifiedIsValid(), modifiedLogicalToDisplay(), modifiedLogicalToOdbc(), modifiedNormalize(), modifiedSet()
property note as HS.FHIR.DTL.vDSTU2.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Comments about the plan.

Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property participant as list of HS.FHIR.DTL.vDSTU2.Model.Element.CarePlan.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");

Who's involved in plan?

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property period as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Time period plan covers.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property relatedPlan as list of HS.FHIR.DTL.vDSTU2.Model.Element.CarePlan.relatedPlan (XMLNAME = "relatedPlan", XMLPROJECTION = "ELEMENT");

Plans related to this one.

Property methods: relatedPlanBuildValueArray(), relatedPlanCollectionToDisplay(), relatedPlanCollectionToOdbc(), relatedPlanDisplayToCollection(), relatedPlanGet(), relatedPlanGetObject(), relatedPlanGetObjectId(), relatedPlanGetSwizzled(), relatedPlanIsValid(), relatedPlanOdbcToCollection(), relatedPlanSet(), relatedPlanSetObject(), relatedPlanSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

proposed | draft | active | completed | cancelled

care-plan-status is the REQUIRED FHIR2 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.vDSTU2.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Who care plan is for.

Patient | Group

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

Information considered as part of plan.

Any FHIR2 Resource may be indicated by this Reference

Property methods: supportBuildValueArray(), supportCollectionToDisplay(), supportCollectionToOdbc(), supportDisplayToCollection(), supportGet(), supportGetObject(), supportGetObjectId(), supportGetSwizzled(), supportIsValid(), supportOdbcToCollection(), supportSet(), supportSetObject(), supportSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab