HS.SDA3.ProgramMembership

serial class HS.SDA3.ProgramMembership extends HS.SDA3.SuperClass

This is used to collect data from the patient program memberships that are
stored in the registry, and return them as SDA. This should only ever come
from the HealthShare registry. It should not be submitted by a data
provider.

In the Viewer Cache, because questionnaire.QPROGRAMS requires an Encounter,
it is linked to the patient's silent encounter, creating one if it does not
yet exist.

Property Inventory

• ActionScope
• Active
• Clinician
• EnteredBy
• EnteredOn
• FromTime
• ProgramDescription
• ProgramID
• ProgramName
• ToTime

Method Inventory

• GetStreamletClass()

Properties

property ActionScope as %String;

Not used.

Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()

property Active as %Boolean [ InitialExpression = 1 ];

Whether the program membership is currently active.

Property methods: ActiveDisplayToLogical(), ActiveGet(), ActiveIsValid(), ActiveLogicalToDisplay(), ActiveLogicalToXSD(), ActiveNormalize(), ActiveSet(), ActiveXSDToLogical()

property Clinician as HS.SDA3.CodeTableDetail.CareProvider;

Clinician responsible for the program membership.

Property methods: ClinicianGet(), ClinicianGetObject(), ClinicianGetObjectId(), ClinicianGetSwizzled(), ClinicianIsEmpty(), ClinicianIsValid(), ClinicianNewObject(), ClinicianSet(), ClinicianSetObject(), ClinicianSetObjectId(), ClinicianUnSwizzle()

property EnteredBy as HS.SDA3.CodeTableDetail.User;

User who entered the program membership. VIEWERLIB: questionnaire.QPROGRAMS(QUESUserDR)

Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()

property EnteredOn as HS.SDA3.TimeStamp;

Timestamp when the program membership was entered. VIEWERLIB: questionnaire.QPROGRAMS(QUESDate) + questionnaire.QPROGRAMS(QUESTime)

Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()

property FromTime as HS.SDA3.TimeStamp;

Effective time of the membership

VIEWERLIB: Not stored

Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()

property ProgramDescription as %String (MAXLEN = 220);

Description of the program. VIEWERLIB: questionnaire.QPROGRAMS(QProgramDescription)

Property methods: ProgramDescriptionDisplayToLogical(), ProgramDescriptionGet(), ProgramDescriptionIsValid(), ProgramDescriptionLogicalToDisplay(), ProgramDescriptionLogicalToOdbc(), ProgramDescriptionNormalize(), ProgramDescriptionSet()

property ProgramID as %String;

Identifier for the program membership record.

Property methods: ProgramIDDisplayToLogical(), ProgramIDGet(), ProgramIDIsValid(), ProgramIDLogicalToDisplay(), ProgramIDLogicalToOdbc(), ProgramIDNormalize(), ProgramIDSet()

property ProgramName as %String;

Name of the program. VIEWERLIB: questionnaire.QPROGRAMS(QProgramName)

Property methods: ProgramNameDisplayToLogical(), ProgramNameGet(), ProgramNameIsValid(), ProgramNameLogicalToDisplay(), ProgramNameLogicalToOdbc(), ProgramNameNormalize(), ProgramNameSet()

property ToTime as HS.SDA3.TimeStamp;

Termination time of the membership

VIEWERLIB: Not stored

Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()

Methods

classmethod GetStreamletClass(pType)

Inherited description: For standard and extended SDA classes, pType will be the short SDA classname For custom SDA classes, pType will be the full SDA classname

Inherited Members

Inherited Properties

• ActionCode
• CustomPairs
• EncounterNumber
• EnteredAt
• ExternalId
• ProvenanceIds
• SdaID
• SourceFormat
• UpdatedOn

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()
• IsDefined()
• LogIgnoredTag()
• LogicalToOdbc()
• OdbcToLogical()
• StartXMLList()
• ToQuickXML()
• ToQuickXMLStream()
• ToQuickXMLString()
• Translate()
• UpdateSDA()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLImportSDAString()
• XMLImportSDAStringUnknown()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()
• old()