Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Element.CarePlan.activity.detail

class HS.FHIR.DTL.vDSTU2.Model.Element.CarePlan.activity.detail extends HS.FHIR.DTL.vDSTU2.Model.Base.BackboneElement

In-line definition of activity.

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.activity.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 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.activity.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.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

diet | drug | encounter | observation | procedure | supply | other

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

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Detail type of activity.

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

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property dailyAmount as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "dailyAmount", XMLPROJECTION = "ELEMENT");
SimpleQuantity

How to consume/day?

Property methods: dailyAmountGet(), dailyAmountGetSwizzled(), dailyAmountIsValid(), dailyAmountNewObject(), dailyAmountSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Extra info describing activity to perform.

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");
Reference

Goals this activity relates to.

Goal

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

Where it should happen.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property performer as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Who will be responsible?

Practitioner | Organization | RelatedPerson | Patient

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property productCodeableConcept as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "productCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

What is to be administered/supplied.

any FHIR2 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "productReference", XMLPROJECTION = "ELEMENT");
Reference

What is to be administered/supplied.

Medication | Substance

Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property prohibited as %Boolean (XMLNAME = "prohibited", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Do NOT do.

Property methods: prohibitedDisplayToLogical(), prohibitedGet(), prohibitedIsValid(), prohibitedLogicalToDisplay(), prohibitedLogicalToXSD(), prohibitedNormalize(), prohibitedSet(), prohibitedXSDToLogical()
property quantity as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
SimpleQuantity

How much to administer/supply/consume.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property reasonCode as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why activity should be done.

any FHIR2 code may be used; activity-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Condition triggering need for activity.

Condition

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property scheduledPeriod as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "scheduledPeriod", XMLPROJECTION = "ELEMENT");
Period

When activity is to occur.

Property methods: scheduledPeriodGet(), scheduledPeriodGetSwizzled(), scheduledPeriodIsValid(), scheduledPeriodNewObject(), scheduledPeriodSet()
property scheduledString as %String (MAXLEN = 1000000, XMLNAME = "scheduledString", XMLPROJECTION = "ATTRIBUTE");
string

When activity is to occur.

Property methods: scheduledStringDisplayToLogical(), scheduledStringGet(), scheduledStringIsValid(), scheduledStringLogicalToDisplay(), scheduledStringLogicalToOdbc(), scheduledStringNormalize(), scheduledStringSet()
property scheduledTiming as HS.FHIR.DTL.vDSTU2.Model.Datatype.Timing (XMLNAME = "scheduledTiming", XMLPROJECTION = "ELEMENT");
Timing

When activity is to occur.

Property methods: scheduledTimingGet(), scheduledTimingGetSwizzled(), scheduledTimingIsValid(), scheduledTimingNewObject(), scheduledTimingSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

not-started | scheduled | in-progress | on-hold | completed | cancelled

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

any FHIR2 code may be used; goal-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab