Skip to main content

HS.FHIR.vSTU3.Model.Resource.CarePlan.Detail

deprecated class HS.FHIR.vSTU3.Model.Resource.CarePlan.Detail extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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

Method 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = CarePlan.Detail;
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.Detail;
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 category as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
High-level categorization of the type of activity in a care plan.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property dailyAmount as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "dailyAmount", XMLPROJECTION = "ELEMENT");
Identifies the quantity expected to be consumed in a given day.
Property methods: dailyAmountGet(), dailyAmountGetSwizzled(), dailyAmountIsValid(), dailyAmountNewObject(), dailyAmountSet()
property definition as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
Property methods: definitionGet(), definitionGetSwizzled(), definitionIsValid(), definitionNewObject(), definitionSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property goal as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "goal", XMLPROJECTION = "ELEMENT");
Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
Property methods: goalBuildValueArray(), goalCollectionToDisplay(), goalCollectionToOdbc(), goalDisplayToCollection(), goalGet(), goalGetObject(), goalGetObjectId(), goalGetSwizzled(), goalIsValid(), goalOdbcToCollection(), goalSet(), goalSetObject(), goalSetObjectId()
property location as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property performer as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Identifies who's expected to be involved in the activity.
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property productCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "productCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "productReference", XMLPROJECTION = "ELEMENT");
Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property prohibited as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "prohibited", XMLPROJECTION = "ELEMENT");
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.
Property methods: prohibitedGet(), prohibitedGetSwizzled(), prohibitedIsValid(), prohibitedNewObject(), prohibitedSet()
property quantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
Identifies the quantity expected to be supplied, administered or consumed by the subject.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property scheduledPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "scheduledPeriod", XMLPROJECTION = "ELEMENT");
Property methods: scheduledPeriodGet(), scheduledPeriodGetSwizzled(), scheduledPeriodIsValid(), scheduledPeriodNewObject(), scheduledPeriodSet()
property scheduledString as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "scheduledString", XMLPROJECTION = "ELEMENT");
Property methods: scheduledStringGet(), scheduledStringGetSwizzled(), scheduledStringIsValid(), scheduledStringNewObject(), scheduledStringSet()
property scheduledTiming as HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "scheduledTiming", XMLPROJECTION = "ELEMENT");
Property methods: scheduledTimingGet(), scheduledTimingGetSwizzled(), scheduledTimingIsValid(), scheduledTimingNewObject(), scheduledTimingSet()
property status as HS.FHIR.vSTU3.Model.Base.CarePlanActivityStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
Identifies what progress is being made for the specific activity.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()

Methods

deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "category" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetDailyAmount(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "dailyAmount" property.
deprecated method SetDefinition(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "definition" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetGoal(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "goal" property.
deprecated method SetLocation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "location" property.
deprecated method SetPerformer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "performer" property.
deprecated method SetProductCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "productCodeableConcept" property.
deprecated method SetProductReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "productReference" property.
deprecated method SetProhibited(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "prohibited" property.
deprecated method SetQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "quantity" property.
deprecated method SetReasonCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonCode" property.
deprecated method SetReasonReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonReference" property.
deprecated method SetScheduledPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "scheduledPeriod" property.
deprecated method SetScheduledString(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "scheduledString" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetStatusReason(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "statusReason" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab