Skip to main content

HS.FHIRModel.R4.CarePlanX.Detail

class HS.FHIRModel.R4.CarePlanX.Detail extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CarePlanX.Detail generated class schema
*****************************************
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 XMLTYPE = R4_CAREPLANX_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 _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _doNotPerform as HS.FHIRModel.R4.Element;
Extensions for doNotPerform
Property methods: _doNotPerformGet(), _doNotPerformGetSwizzled(), _doNotPerformIsValid(), _doNotPerformNewObject(), _doNotPerformSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _kind as HS.FHIRModel.R4.Element;
Extensions for kind
Property methods: _kindGet(), _kindGetSwizzled(), _kindIsValid(), _kindNewObject(), _kindSet()
property _scheduledString as HS.FHIRModel.R4.Element;
Extensions for scheduledString
Property methods: _scheduledStringGet(), _scheduledStringGetSwizzled(), _scheduledStringIsValid(), _scheduledStringNewObject(), _scheduledStringSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
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.FHIRModel.R4.Quantity;
Identifies the quantity expected to be consumed in a given day.
Property methods: dailyAmountGet(), dailyAmountGetSwizzled(), dailyAmountIsValid(), dailyAmountNewObject(), dailyAmountSet()
property description as %String;
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: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property doNotPerform as %Boolean;
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property goal as HS.FHIRModel.R4.SeqOfReference;
Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
Property methods: goalGet(), goalGetSwizzled(), goalIsValid(), goalNewObject(), goalSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
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 activity.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property kind as %String;
A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property location as HS.FHIRModel.R4.Reference;
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property performer as HS.FHIRModel.R4.SeqOfReference;
Identifies who's expected to be involved in the activity.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property productCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Identifies the food, drug or other product to be consumed or supplied in the activity.
Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIRModel.R4.Reference;
Identifies the food, drug or other product to be consumed or supplied in the activity.
Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property quantity as HS.FHIRModel.R4.Quantity;
Identifies the quantity expected to be supplied, administered or consumed by the subject.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
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: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property scheduledPeriod as HS.FHIRModel.R4.Period;
The period, timing or frequency upon which the described activity is to occur.
Property methods: scheduledPeriodGet(), scheduledPeriodGetSwizzled(), scheduledPeriodIsValid(), scheduledPeriodNewObject(), scheduledPeriodSet()
property scheduledString as %String;
The period, timing or frequency upon which the described activity is to occur.
Property methods: scheduledStringDisplayToLogical(), scheduledStringGet(), scheduledStringIsValid(), scheduledStringLogicalToDisplay(), scheduledStringLogicalToOdbc(), scheduledStringNormalize(), scheduledStringSet()
property scheduledTiming as HS.FHIRModel.R4.Timing;
The period, timing or frequency upon which the described activity is to occur.
Property methods: scheduledTimingGet(), scheduledTimingGetSwizzled(), scheduledTimingIsValid(), scheduledTimingNewObject(), scheduledTimingSet()
property status as %String (VALUELIST = ",not-started,scheduled,in-progress,on-hold,completed,cancelled,stopped,unknown,entered-in-error");
Identifies what progress is being made for the specific activity.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()

Methods

method IncludeCode()
method IncludeDailyAmount()
method IncludeExtension()
method IncludeGoal()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeLocation()
method IncludeModifierExtension()
method IncludePerformer()
method IncludeProductCodeableConcept()
method IncludeProductReference()
method IncludeQuantity()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeScheduledPeriod()
method IncludeScheduledTiming()
method IncludeStatusReason()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab