HS.SDA3.CarePlan
serial class HS.SDA3.CarePlan extends HS.SDA3.SuperClass
Property Inventory
- ActionCode
- ActionScope
- Authors
- CreatedBy
- CreatedTime
- EncounterNumber
- EnteredAt
- EnteredBy
- EnteredOn
- Extension
- ExternalId
- FromTime
- GoalIds
- HealthConcernIds
- Intent
- Interventions
- Narrative
- NarrativeStatus
- Organizations
- Outcomes
- Providers
- SetId
- Status
- SubType
- SupportContacts
- ToTime
- Type
- UpdatedOn
- Version
Properties
property ActionCode as %String;
Not used.
Property methods: ActionCodeDisplayToLogical(), ActionCodeGet(), ActionCodeIsValid(), ActionCodeLogicalToDisplay(), ActionCodeLogicalToOdbc(), ActionCodeNormalize(), ActionCodeSet()
property ActionScope as %String;
Not used.
Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()
property Authors as list of HS.SDA3.DocumentProvider;
The authors of a care plan
VIEWERLIB: Not stored
Property methods: AuthorsBuildValueArray(), AuthorsCollectionToDisplay(), AuthorsCollectionToOdbc(), AuthorsDisplayToCollection(), AuthorsGet(), AuthorsGetObject(), AuthorsGetObjectId(), AuthorsGetSwizzled(), AuthorsIsValid(), AuthorsOdbcToCollection(), AuthorsSet(), AuthorsSetObject(), AuthorsSetObjectId()
property CreatedBy as HS.SDA3.CodeTableDetail.User;
VIEWERLIB: Not stored
Property methods: CreatedByGet(), CreatedByGetObject(), CreatedByGetObjectId(), CreatedByGetSwizzled(), CreatedByIsEmpty(), CreatedByIsValid(), CreatedByNewObject(), CreatedBySet(), CreatedBySetObject(), CreatedBySetObjectId(), CreatedByUnSwizzle()
property CreatedTime as HS.SDA3.TimeStamp;
VIEWERLIB: Not stored
Property methods: CreatedTimeDisplayToLogical(), CreatedTimeGet(), CreatedTimeIsValid(), CreatedTimeLogicalToDisplay(), CreatedTimeLogicalToTimeStamp(), CreatedTimeLogicalToXSD(), CreatedTimeNormalize(), CreatedTimeOdbcToLogical(), CreatedTimeSet(), CreatedTimeXSDToLogical()
property EncounterNumber as %String (MAXLEN = 220);
Not used.
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
property EnteredAt as HS.SDA3.CodeTableDetail.Organization;
Not used.
Property methods: EnteredAtGet(), EnteredAtGetObject(), EnteredAtGetObjectId(), EnteredAtGetSwizzled(), EnteredAtIsEmpty(), EnteredAtIsValid(), EnteredAtNewObject(), EnteredAtSet(), EnteredAtSetObject(), EnteredAtSetObjectId(), EnteredAtUnSwizzle()
property EnteredBy as HS.SDA3.CodeTableDetail.User;
VIEWERLIB: Not stored
Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()
property EnteredOn as HS.SDA3.TimeStamp;
VIEWERLIB: Not stored
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
property Extension as HS.Local.SDA3.CarePlanExtension;
VIEWERLIB: Not stored
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property ExternalId as %String (MAXLEN = 220);
Used for the care plan identifier
Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()
property FromTime as HS.SDA3.TimeStamp;
VIEWERLIB: Not stored
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property GoalIds as list of %String;
ExternalIds of Goals in this care plan
Property methods: GoalIdsBuildValueArray(), GoalIdsCollectionToDisplay(), GoalIdsCollectionToOdbc(), GoalIdsDisplayToCollection(), GoalIdsDisplayToLogical(), GoalIdsGet(), GoalIdsGetObject(), GoalIdsGetObjectId(), GoalIdsGetSwizzled(), GoalIdsIsValid(), GoalIdsLogicalToDisplay(), GoalIdsLogicalToOdbc(), GoalIdsNormalize(), GoalIdsOdbcToCollection(), GoalIdsSet(), GoalIdsSetObject(), GoalIdsSetObjectId()
property HealthConcernIds as list of %String;
ExternalIds of Health Concerns in this care plan
Property methods: HealthConcernIdsBuildValueArray(), HealthConcernIdsCollectionToDisplay(), HealthConcernIdsCollectionToOdbc(), HealthConcernIdsDisplayToCollection(), HealthConcernIdsDisplayToLogical(), HealthConcernIdsGet(), HealthConcernIdsGetObject(), HealthConcernIdsGetObjectId(), HealthConcernIdsGetSwizzled(), HealthConcernIdsIsValid(), HealthConcernIdsLogicalToDisplay(), HealthConcernIdsLogicalToOdbc(), HealthConcernIdsNormalize(), HealthConcernIdsOdbcToCollection(), HealthConcernIdsSet(), HealthConcernIdsSetObject(), HealthConcernIdsSetObjectId()
property Intent as HS.SDA3.CodeTableDetail.CarePlanIntent;
VIEWERLIB: Not stored
Indicates the level of authority/intentionality associated with
the care plan and where the care plan fits into the workflow chain.
Property methods: IntentGet(), IntentGetObject(), IntentGetObjectId(), IntentGetSwizzled(), IntentIsEmpty(), IntentIsValid(), IntentNewObject(), IntentSet(), IntentSetObject(), IntentSetObjectId(), IntentUnSwizzle()
property Interventions as list of HS.SDA3.Intervention;
Interventions in this care plan
Property methods: InterventionsBuildValueArray(), InterventionsCollectionToDisplay(), InterventionsCollectionToOdbc(), InterventionsDisplayToCollection(), InterventionsGet(), InterventionsGetObject(), InterventionsGetObjectId(), InterventionsGetSwizzled(), InterventionsIsValid(), InterventionsOdbcToCollection(), InterventionsSet(), InterventionsSetObject(), InterventionsSetObjectId()
property Narrative as %String);
VIEWERLIB: Not stored
A human-readable narrative that contains a summary of the care plan
content and can be used to represent the content to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative.
Property methods: NarrativeDisplayToLogical(), NarrativeGet(), NarrativeIsValid(), NarrativeLogicalToDisplay(), NarrativeLogicalToOdbc(), NarrativeNormalize(), NarrativeSet()
property NarrativeStatus as HS.SDA3.CodeTableDetail.NarrativeStatus;
VIEWERLIB: Not stored
Specifies whether the narrative is entirely generated from the
core elements in the content or whether the narrative may contain
additional information not found in the structured data.
Property methods: NarrativeStatusGet(), NarrativeStatusGetObject(), NarrativeStatusGetObjectId(), NarrativeStatusGetSwizzled(), NarrativeStatusIsEmpty(), NarrativeStatusIsValid(), NarrativeStatusNewObject(), NarrativeStatusSet(), NarrativeStatusSetObject(), NarrativeStatusSetObjectId(), NarrativeStatusUnSwizzle()
property Organizations as list of HS.SDA3.DocumentOrganization;
The list of organizations (along with roles and dates) associated with a care plan
VIEWERLIB: Not stored
Property methods: OrganizationsBuildValueArray(), OrganizationsCollectionToDisplay(), OrganizationsCollectionToOdbc(), OrganizationsDisplayToCollection(), OrganizationsGet(), OrganizationsGetObject(), OrganizationsGetObjectId(), OrganizationsGetSwizzled(), OrganizationsIsValid(), OrganizationsOdbcToCollection(), OrganizationsSet(), OrganizationsSetObject(), OrganizationsSetObjectId()
property Outcomes as list of HS.SDA3.Outcome;
Outcomes in this care plan
Property methods: OutcomesBuildValueArray(), OutcomesCollectionToDisplay(), OutcomesCollectionToOdbc(), OutcomesDisplayToCollection(), OutcomesGet(), OutcomesGetObject(), OutcomesGetObjectId(), OutcomesGetSwizzled(), OutcomesIsValid(), OutcomesOdbcToCollection(), OutcomesSet(), OutcomesSetObject(), OutcomesSetObjectId()
property Providers as list of HS.SDA3.DocumentProvider;
The list of individual care providers (along with roles and dates) associated with a care plan
VIEWERLIB: Not stored
Property methods: ProvidersBuildValueArray(), ProvidersCollectionToDisplay(), ProvidersCollectionToOdbc(), ProvidersDisplayToCollection(), ProvidersGet(), ProvidersGetObject(), ProvidersGetObjectId(), ProvidersGetSwizzled(), ProvidersIsValid(), ProvidersOdbcToCollection(), ProvidersSet(), ProvidersSetObject(), ProvidersSetObjectId()
property SetId as %String;
The published care plan set id, taken from CCDA /ClinicalDocument/SetId
VIEWERLIB: Not stored
Property methods: SetIdDisplayToLogical(), SetIdGet(), SetIdIsValid(), SetIdLogicalToDisplay(), SetIdLogicalToOdbc(), SetIdNormalize(), SetIdSet()
property Status as %String;
Currently, possible values are: "A" - Active, "I" - Inactive
Derived from the document %IsActive property
VIEWERLIB: Not stored
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property SubType as HS.SDA3.CodeTableDetail.CarePlanSubType;
VIEWERLIB: Not stored
Property methods: SubTypeGet(), SubTypeGetObject(), SubTypeGetObjectId(), SubTypeGetSwizzled(), SubTypeIsEmpty(), SubTypeIsValid(), SubTypeNewObject(), SubTypeSet(), SubTypeSetObject(), SubTypeSetObjectId(), SubTypeUnSwizzle()
property SupportContacts as list of HS.SDA3.SupportContact;
The list of individual support contacts (along with roles and dates) associated with a care plan
VIEWERLIB: Not stored
Property methods: SupportContactsBuildValueArray(), SupportContactsCollectionToDisplay(), SupportContactsCollectionToOdbc(), SupportContactsDisplayToCollection(), SupportContactsGet(), SupportContactsGetObject(), SupportContactsGetObjectId(), SupportContactsGetSwizzled(), SupportContactsIsValid(), SupportContactsOdbcToCollection(), SupportContactsSet(), SupportContactsSetObject(), SupportContactsSetObjectId()
property ToTime as HS.SDA3.TimeStamp;
VIEWERLIB: Not stored
Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()
property Type as HS.SDA3.CodeTableDetail.CarePlanType;
VIEWERLIB: Not stored
Property methods: TypeGet(), TypeGetObject(), TypeGetObjectId(), TypeGetSwizzled(), TypeIsEmpty(), TypeIsValid(), TypeNewObject(), TypeSet(), TypeSetObject(), TypeSetObjectId(), TypeUnSwizzle()
property UpdatedOn as HS.SDA3.TimeStamp;
Not used.
Property methods: UpdatedOnDisplayToLogical(), UpdatedOnGet(), UpdatedOnIsValid(), UpdatedOnLogicalToDisplay(), UpdatedOnLogicalToTimeStamp(), UpdatedOnLogicalToXSD(), UpdatedOnNormalize(), UpdatedOnOdbcToLogical(), UpdatedOnSet(), UpdatedOnXSDToLogical()
property Version as %String;
The published care plan version, taken from the document metadata %VersionNumber
VIEWERLIB: Not stored
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SyncObjectIn()
- %SyncTransport()
- %ValidateObject()
- EndXMLList()
- GetStreamletClass()
- IsDefined()
- LogIgnoredTag()
- LogicalToOdbc()
- OdbcToLogical()
- StartXMLList()
- ToQuickXML()
- ToQuickXMLStream()
- ToQuickXMLString()
- Translate()
- UpdateSDA()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportSDAString()
- XMLImportSDAStringUnknown()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()