HS.Push.Types.DocumentInfo
abstract class HS.Push.Types.DocumentInfo
Property Inventory
- Address
- AssigningAuthority
- AssigningAuthorityOID
- Attachments
- BlindList
- CCList
- DOB
- DocumentId
- Download
- Draft
- EventType
- Facility
- FacilityOID
- FirstName
- Identifiers
- InfoTypes
- IsExternal
- LastName
- MPIID
- MRN
- RecipientList
- RepositoryGWEndPoint
- RepositoryGWID
- RepositoryGateway
- SenderEmail
- SenderID
- SenderName
- Sent
- Sex
- Subscription
- ToList
Method Inventory
Parameters
parameter XMLIGNOREINVALIDTAG = 1;
Properties
property Address as HS.Types.Address;
Property methods: AddressGet(), AddressGetObject(), AddressGetObjectId(), AddressGetSwizzled(), AddressIsEmpty(), AddressIsValid(), AddressNewObject(), AddressSet(), AddressSetObject(), AddressSetObjectId(), AddressUnSwizzle()
property AssigningAuthority as HS.HC.DataType.AssignAuthName;
Assigning Authority for the MRN
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property AssigningAuthorityOID as %String (MAXLEN = 255);
for direct input, we get the AA's OID, and will determine the AA, if needed, later
Property methods: AssigningAuthorityOIDDisplayToLogical(), AssigningAuthorityOIDGet(), AssigningAuthorityOIDIsValid(), AssigningAuthorityOIDLogicalToDisplay(), AssigningAuthorityOIDLogicalToOdbc(), AssigningAuthorityOIDNormalize(), AssigningAuthorityOIDSet()
property Attachments as list of HS.Push.Types.DocumentAttachment;
Property methods: AttachmentsBuildValueArray(), AttachmentsCollectionToDisplay(), AttachmentsCollectionToOdbc(), AttachmentsDisplayToCollection(), AttachmentsGet(), AttachmentsGetObject(), AttachmentsGetObjectId(), AttachmentsGetSwizzled(), AttachmentsIsValid(), AttachmentsOdbcToCollection(), AttachmentsSet(), AttachmentsSetObject(), AttachmentsSetObjectId()
property BlindList as %String);
Property methods: BlindListDisplayToLogical(), BlindListGet(), BlindListIsValid(), BlindListLogicalToDisplay(), BlindListLogicalToOdbc(), BlindListNormalize(), BlindListSet()
property CCList as %String);
Property methods: CCListDisplayToLogical(), CCListGet(), CCListIsValid(), CCListLogicalToDisplay(), CCListLogicalToOdbc(), CCListNormalize(), CCListSet()
property DOB as %Date (FORMAT = 3);
Property methods: DOBDisplayToLogical(), DOBGet(), DOBIsValid(), DOBLogicalToDisplay(), DOBLogicalToOdbc(), DOBNormalize(), DOBOdbcToLogical(), DOBSet()
property DocumentId as %String (MAXLEN = 256);
The document ID on the repository
Property methods: DocumentIdDisplayToLogical(), DocumentIdGet(), DocumentIdIsValid(), DocumentIdLogicalToDisplay(), DocumentIdLogicalToOdbc(), DocumentIdNormalize(), DocumentIdSet()
property Download as %Boolean [ InitialExpression = 0 ];
Property methods: DownloadDisplayToLogical(), DownloadGet(), DownloadIsValid(), DownloadLogicalToDisplay(), DownloadNormalize(), DownloadSet()
property Draft as %Boolean [ InitialExpression = 0 ];
Property methods: DraftDisplayToLogical(), DraftGet(), DraftIsValid(), DraftLogicalToDisplay(), DraftNormalize(), DraftSet()
property EventType as %String;
Property methods: EventTypeDisplayToLogical(), EventTypeGet(), EventTypeIsValid(), EventTypeLogicalToDisplay(), EventTypeLogicalToOdbc(), EventTypeNormalize(), EventTypeSet()
property Facility as HS.Types.Facility;
Facility for this patient info
Property methods: FacilityDisplayToLogical(), FacilityGet(), FacilityIsValid(), FacilityLogicalToDisplay(), FacilityLogicalToOdbc(), FacilityNormalize(), FacilitySet()
property FacilityOID as %String (MAXLEN = 255);
for direct input, we get the facility's OID, and will determine the Facility, if needed, later
Property methods: FacilityOIDDisplayToLogical(), FacilityOIDGet(), FacilityOIDIsValid(), FacilityOIDLogicalToDisplay(), FacilityOIDLogicalToOdbc(), FacilityOIDNormalize(), FacilityOIDSet()
property FirstName as HS.Types.PersonName.Given;
Person's firstname
Property methods: FirstNameDisplayToLogical(), FirstNameGet(), FirstNameIsValid(), FirstNameLogicalToDisplay(), FirstNameLogicalToOdbc(), FirstNameNormalize(), FirstNameSet()
property Identifiers as %String (MAXLEN = 500);
Patient identifier(s) - text that may contain lists of AA+MRNs, etc.
For messages automatically pushed from a facility, with be AA-MRN
Property methods: IdentifiersDisplayToLogical(), IdentifiersGet(), IdentifiersIsValid(), IdentifiersLogicalToDisplay(), IdentifiersLogicalToOdbc(), IdentifiersNormalize(), IdentifiersSet()
property InfoTypes as list of %String);
Property methods: InfoTypesBuildValueArray(), InfoTypesCollectionToDisplay(), InfoTypesCollectionToOdbc(), InfoTypesDisplayToCollection(), InfoTypesDisplayToLogical(), InfoTypesGet(), InfoTypesGetObject(), InfoTypesGetObjectId(), InfoTypesGetSwizzled(), InfoTypesIsValid(), InfoTypesLogicalToDisplay(), InfoTypesLogicalToOdbc(), InfoTypesNormalize(), InfoTypesOdbcToCollection(), InfoTypesSet(), InfoTypesSetObject(), InfoTypesSetObjectId()
property IsExternal as %Boolean [ InitialExpression = 0 ];
Property methods: IsExternalDisplayToLogical(), IsExternalGet(), IsExternalIsValid(), IsExternalLogicalToDisplay(), IsExternalNormalize(), IsExternalSet()
property LastName as HS.Types.PersonName.Family;
Person's lastname
Property methods: LastNameDisplayToLogical(), LastNameGet(), LastNameIsValid(), LastNameLogicalToDisplay(), LastNameLogicalToOdbc(), LastNameNormalize(), LastNameSet()
property MPIID as %String;
For direct input, this will be computed later, as needed
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property MRN as HS.Types.MRN;
This patient's MRN (from the above assigning authority)
Property methods: MRNDisplayToLogical(), MRNGet(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property RecipientList as list of HS.Push.Types.RecipientSerialInfo;
Once a document is registered, the RecipientList, ToList, CCList, and BlindList are for informational purposes only.
As the message gets registered, if it's not coming from a subscription, the reg/notify manager looks at the recipient
list, computes the displayable ToList, CCList, and BlindList, and looks at the recipient number specified in the message
to determine which recipient in the list this is for (0=sender), and then fills in the datat that would otherwise come
from the subscription
Property methods: RecipientListBuildValueArray(), RecipientListCollectionToDisplay(), RecipientListCollectionToOdbc(), RecipientListDisplayToCollection(), RecipientListGet(), RecipientListGetObject(), RecipientListGetObjectId(), RecipientListGetSwizzled(), RecipientListIsValid(), RecipientListOdbcToCollection(), RecipientListSet(), RecipientListSetObject(), RecipientListSetObjectId()
property RepositoryGWEndPoint as %String (MAXLEN = 500) [ Calculated ];
Calculation will contain the endpoint URL to get to the edge gateway to contact the repository manager
Property methods: RepositoryGWEndPointCompute(), RepositoryGWEndPointDisplayToLogical(), RepositoryGWEndPointGet(), RepositoryGWEndPointIsValid(), RepositoryGWEndPointLogicalToDisplay(), RepositoryGWEndPointLogicalToOdbc(), RepositoryGWEndPointNormalize(), RepositoryGWEndPointSQLCompute()
property RepositoryGWID as %String;
the ID of the edge gateway in the HS.Gateway.Config table
Property methods: RepositoryGWIDDisplayToLogical(), RepositoryGWIDGet(), RepositoryGWIDIsValid(), RepositoryGWIDLogicalToDisplay(), RepositoryGWIDLogicalToOdbc(), RepositoryGWIDNormalize(), RepositoryGWIDSet()
property RepositoryGateway as %String (MAXLEN = 500);
Deprecated - newer use will use RepositoryGWID and EndPoint
Property methods: RepositoryGatewayDisplayToLogical(), RepositoryGatewayGet(), RepositoryGatewayIsValid(), RepositoryGatewayLogicalToDisplay(), RepositoryGatewayLogicalToOdbc(), RepositoryGatewayNormalize(), RepositoryGatewaySet()
property SenderEmail as %String (MAXLEN = 256);
For direct e-mail, the sender's e-mail address
Property methods: SenderEmailDisplayToLogical(), SenderEmailGet(), SenderEmailIsValid(), SenderEmailLogicalToDisplay(), SenderEmailLogicalToOdbc(), SenderEmailNormalize(), SenderEmailSet()
property SenderID as %String;
Sender ID (clinician ID if sent by clinician, in future might also be system ID if sent from facility->system)
Property methods: SenderIDDisplayToLogical(), SenderIDGet(), SenderIDIsValid(), SenderIDLogicalToDisplay(), SenderIDLogicalToOdbc(), SenderIDNormalize(), SenderIDSet()
property SenderName as %String (MAXLEN = 500);
Sender Name, for display in message list - can be clinician or facility name
Property methods: SenderNameDisplayToLogical(), SenderNameGet(), SenderNameIsValid(), SenderNameLogicalToDisplay(), SenderNameLogicalToOdbc(), SenderNameNormalize(), SenderNameSet()
property Sent as %TimeStamp;
Property methods: SentDisplayToLogical(), SentGet(), SentIsValid(), SentLogicalToDisplay(), SentNormalize(), SentOdbcToLogical(), SentSet()
property Sex as %String;
Property methods: SexDisplayToLogical(), SexGet(), SexIsValid(), SexLogicalToDisplay(), SexLogicalToOdbc(), SexNormalize(), SexSet()
property Subscription as HS.Types.SubscriptionSerialInfo;
Property methods: SubscriptionGet(), SubscriptionGetObject(), SubscriptionGetObjectId(), SubscriptionGetSwizzled(), SubscriptionIsEmpty(), SubscriptionIsValid(), SubscriptionNewObject(), SubscriptionSet(), SubscriptionSetObject(), SubscriptionSetObjectId(), SubscriptionUnSwizzle()
property ToList as %String);
Property methods: ToListDisplayToLogical(), ToListGet(), ToListIsValid(), ToListLogicalToDisplay(), ToListLogicalToOdbc(), ToListNormalize(), ToListSet()
Methods
classmethod GetEventName(pEventType) as %String
classmethod GetRepositoryGWEndPoint(pGWID)