Skip to main content

HS.Message.PatClinRelationship

class HS.Message.PatClinRelationship extends HS.Util.WebServices.ListItem, HS.Util.EnsRequest, HS.Types.RequestInfo

This is the generic transport message for patient-clinician relationships

Property Inventory

Properties

property AssigningAuthority as %String (MAXLEN = 64);
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
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 EncounterNumber as %String (MAXLEN = 220);
If Encounter entity
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
property EntityType as %String [ InitialExpression = "MPIID" ];
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 Facility as HS.Types.Facility;
Property methods: FacilityDisplayToLogical(), FacilityGet(), FacilityIsValid(), FacilityLogicalToDisplay(), FacilityLogicalToOdbc(), FacilityNormalize(), FacilitySet()
property Identifier as %String;
Format AssigningAuthority^Ident#
Property methods: IdentifierDisplayToLogical(), IdentifierGet(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogicalToOdbc(), IdentifierNormalize(), IdentifierSet()
property MPIID as %String;
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property MRN as HS.Types.MRN;
MRN, Facility, and AssigningAuthority are populated for MRN or Encounter entity types
Property methods: MRNDisplayToLogical(), MRNGet(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property PatClinRelationshipId as %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: PatClinRelationshipIdDisplayToLogical(), PatClinRelationshipIdGet(), PatClinRelationshipIdIsValid(), PatClinRelationshipIdLogicalToDisplay(), PatClinRelationshipIdLogicalToOdbc(), PatClinRelationshipIdNormalize(), PatClinRelationshipIdSet()
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

Inherited Methods

FeedbackOpens in a new tab