HS.Message.AnalyticsPatClinRelationship
class HS.Message.AnalyticsPatClinRelationship extends HS.Util.WebServices.ListItem, HS.Util.EnsRequest, HS.Types.RequestInfo
This is the transport message for patient-clinician relationships organized by AnalyticsIdAll array properties should use the AnalyticsId as their key - ArrayProperty(AnalyticsId)=Value
This way all information from HS.Message.PatClinRelationship can be stored for each patient
Property Inventory
- AnalyticsIdList
- CGName
- CName
- Clin
- Clinician
- ClinicianGroup
- DischargeOffset
- EntityType
- ExpirationDate
- Identifier
- PatClinRelationshipIdArray
- PolicyId
- RelName
- Relationship
- StartDate
- Status
Properties
property AnalyticsIdList as list of %String;
Property methods: AnalyticsIdListBuildValueArray(), AnalyticsIdListCollectionToDisplay(), AnalyticsIdListCollectionToOdbc(), AnalyticsIdListDisplayToCollection(), AnalyticsIdListDisplayToLogical(), AnalyticsIdListGet(), AnalyticsIdListGetObject(), AnalyticsIdListGetObjectId(), AnalyticsIdListGetSwizzled(), AnalyticsIdListIsValid(), AnalyticsIdListLogicalToDisplay(), AnalyticsIdListLogicalToOdbc(), AnalyticsIdListNormalize(), AnalyticsIdListOdbcToCollection(), AnalyticsIdListSet(), AnalyticsIdListSetObject(), AnalyticsIdListSetObjectId()
property CGName as %String;
Will contain the clinician group name, if present
Property methods: CGNameDisplayToLogical(), CGNameGet(), CGNameIsValid(), CGNameLogicalToDisplay(), CGNameLogicalToOdbc(), CGNameNormalize(), CGNameSet()
property CName as %String;
Will contain the clinician name, if present
Property methods: CNameDisplayToLogical(), CNameGet(), CNameIsValid(), CNameLogicalToDisplay(), CNameLogicalToOdbc(), CNameNormalize(), CNameSet()
property Clin as %String;
Will contain one of CName, CGName, or Identifier
Property methods: ClinDisplayToLogical(), ClinGet(), ClinIsValid(), ClinLogicalToDisplay(), ClinLogicalToOdbc(), ClinNormalize(), ClinSet()
property Clinician as %String;
Exactly One of Clinician, ClinicianGroup, or Identifier will be populated
This will hold the clinician ID
Property methods: ClinicianDisplayToLogical(), ClinicianGet(), ClinicianIsValid(), ClinicianLogicalToDisplay(), ClinicianLogicalToOdbc(), ClinicianNormalize(), ClinicianSet()
property ClinicianGroup as %String;
The group's ID
Property methods: ClinicianGroupDisplayToLogical(), ClinicianGroupGet(), ClinicianGroupIsValid(), ClinicianGroupLogicalToDisplay(), ClinicianGroupLogicalToOdbc(), ClinicianGroupNormalize(), ClinicianGroupSet()
property DischargeOffset as %String;
Format (-)#number of days. This will only be populated for Admission basis relationships
where the Stop is based on discharge date, and we don’t yet have a discharge date
Property methods: DischargeOffsetDisplayToLogical(), DischargeOffsetGet(), DischargeOffsetIsValid(), DischargeOffsetLogicalToDisplay(), DischargeOffsetLogicalToOdbc(), DischargeOffsetNormalize(), DischargeOffsetSet()
property EntityType as %String;
MPIID, MRN, or Encounter
Property methods: EntityTypeDisplayToLogical(), EntityTypeGet(), EntityTypeIsValid(), EntityTypeLogicalToDisplay(), EntityTypeLogicalToOdbc(), EntityTypeNormalize(), EntityTypeSet()
property ExpirationDate as %Date;
Property methods: ExpirationDateDisplayToLogical(), ExpirationDateGet(), ExpirationDateIsValid(), ExpirationDateLogicalToDisplay(), ExpirationDateLogicalToOdbc(), ExpirationDateLogicalToXSD(), ExpirationDateNormalize(), ExpirationDateOdbcToLogical(), ExpirationDateSet(), ExpirationDateXSDToLogical()
property Identifier as %String;
Format AssigningAuthority^Ident#
Property methods: IdentifierDisplayToLogical(), IdentifierGet(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogicalToOdbc(), IdentifierNormalize(), IdentifierSet()
property PatClinRelationshipIdArray as array of %String;
Populated for editing an existing relationship. Normally, the date range will always use
a "widening" de-duplication algorithm. Edits can narrow an existing relationship
Property methods: PatClinRelationshipIdArrayBuildValueArray(), PatClinRelationshipIdArrayCollectionToDisplay(), PatClinRelationshipIdArrayCollectionToOdbc(), PatClinRelationshipIdArrayDisplayToCollection(), PatClinRelationshipIdArrayDisplayToLogical(), PatClinRelationshipIdArrayGet(), PatClinRelationshipIdArrayGetObject(), PatClinRelationshipIdArrayGetObjectId(), PatClinRelationshipIdArrayGetSwizzled(), PatClinRelationshipIdArrayIsValid(), PatClinRelationshipIdArrayLogicalToDisplay(), PatClinRelationshipIdArrayLogicalToOdbc(), PatClinRelationshipIdArrayNormalize(), PatClinRelationshipIdArrayOdbcToCollection(), PatClinRelationshipIdArraySet(), PatClinRelationshipIdArraySetObject(), PatClinRelationshipIdArraySetObjectId()
property PolicyId as %String;
Populated only for adding audit info for relationships created by inference policies
Property methods: PolicyIdDisplayToLogical(), PolicyIdGet(), PolicyIdIsValid(), PolicyIdLogicalToDisplay(), PolicyIdLogicalToOdbc(), PolicyIdNormalize(), PolicyIdSet()
property RelName as %String;
Will contain the relationship name
Property methods: RelNameDisplayToLogical(), RelNameGet(), RelNameIsValid(), RelNameLogicalToDisplay(), RelNameLogicalToOdbc(), RelNameNormalize(), RelNameSet()
property Relationship as %String;
The relationship type ID
Property methods: RelationshipDisplayToLogical(), RelationshipGet(), RelationshipIsValid(), RelationshipLogicalToDisplay(), RelationshipLogicalToOdbc(), RelationshipNormalize(), RelationshipSet()
property StartDate as %Date;
Property methods: StartDateDisplayToLogical(), StartDateGet(), StartDateIsValid(), StartDateLogicalToDisplay(), StartDateLogicalToOdbc(), StartDateLogicalToXSD(), StartDateNormalize(), StartDateOdbcToLogical(), StartDateSet(), StartDateXSDToLogical()
property Status as %Status;
for messaging
Property methods: StatusGet(), StatusIsValid(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusSet(), StatusXSDToLogical()
Inherited Members
Inherited Properties
- %ClearFields
- %id
- %seriesCount
- %seriesNames
- %source
- AdditionalInfo
- AuthBy
- AuthRole
- AuthType
- BTGReason
- BreakTheGlass
- ClinicalTypes
- Consent
- CustomAuditInfo
- HSCoreVersion
- HSMinVersion
- ID
- Name
- RequestId
- RequestingForProxyID
- RequestingForProxyUserID
- RequestingGateway
- RequestingUser
- RequestingUserRoles
- SAMLData
- Signature
- Type
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %CompareContents()
- %ComposeOid()
- %ConstructClone()
- %CreateModelInstance()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DeleteModel()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DrawHTMLForm()
- %DrawHTMLTable()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetContentType()
- %GetJSValidationCode()
- %GetLock()
- %GetParameter()
- %GetPropertyInfo()
- %GetSwizzleObject()
- %Id()
- %InitExtentData()
- %InsertBatch()
- %InvokeAction()
- %IsA()
- %IsModified()
- %IsNull()
- %IsReadOnly()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONNew()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnCopyDataFromModel()
- %OnCopyDataToModel()
- %OnDeleteFinally()
- %OnDeleteModel()
- %OnDeleteSource()
- %OnDetermineClass()
- %OnGetPropertyInfo()
- %OnInvokeAction()
- %OnLoadModel()
- %OnNewSource()
- %OnOpenFinally()
- %OnOpenSource()
- %OnSaveFinally()
- %OnSaveSource()
- %OnStoreModel()
- %OnSubmit()
- %OnTimeout()
- %Open()
- %OpenId()
- %OpenModel()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %ProcessSubmit()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SaveModel()
- %SerializeObject()
- %SetModified()
- %ShowContents()
- %ShowContentsHead()
- %SortBegin()
- %SortEnd()
- %SubmitHandler()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- CopyFrom()
- GenerateGenericDAOFromObject()
- GetStatsDimension()
- GetUserInfo()
- NewResponse()
- OnShowJSONContents()
- OnShowXMLContents()
- OutputFormattedJSON()
- RequestInfoToXMLMessage()
- WriteNoJSONFormat()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLMessageToRequestInfo()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()