Skip to main content

HS.SDA3.ClinicalRelationship

serial class HS.SDA3.ClinicalRelationship extends HS.SDA3.SuperClass

This is used to collect data from the clinician-patient relationships that
are stored in the Registry (as HS.Push.PatientClinicianRelationship), and
return them as SDA. This should only ever come from the HealthShare
Registry. It should not be submitted by a data provider.

Property Inventory

Method Inventory

Properties

property ActionScope as %String;
Not used.
Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()
property Clinician as HS.SDA3.CodeTableDetail.CareProvider;
If the relationship is between a patient and an individual clinician, this
is that clinician. The Code will be populated by the ID of the
HS.Push.PatientClinicianRelationship:Clinician, and the SDACodingStandard
will be set to "HSClinician". Other properties from the User/Clinician
Registry (NameParts, Addresses, Telecoms) will populate this Clinician as
well. This property will only be populated for individual relationships.

Viewer cache:
If present, Clinician will populate CPCareProvDR, else ClinicianGroup will
be used.

SDATableName=CareProvider, ViewerClass=User.HS.CTCareProv
VIEWERLIB: User.HS.PAPersonCareProvider(CPCareProvDR)

.CareProviderType
The Code and Description come from the Name and Description of the
HS.Push.PatientClinicianRelationship:Relationship. The SDACodingStandard is
set to "HSRelationshipType".
Property methods: ClinicianGet(), ClinicianGetObject(), ClinicianGetObjectId(), ClinicianGetSwizzled(), ClinicianGroupGet(), ClinicianGroupGetObject(), ClinicianGroupGetObjectId(), ClinicianGroupGetSwizzled(), ClinicianGroupIsEmpty(), ClinicianGroupIsValid(), ClinicianGroupNewObject(), ClinicianGroupSet(), ClinicianGroupSetObject(), ClinicianGroupSetObjectId(), ClinicianGroupUnSwizzle(), ClinicianIsEmpty(), ClinicianIsValid(), ClinicianNewObject(), ClinicianSet(), ClinicianSetObject(), ClinicianSetObjectId(), ClinicianUnSwizzle()
property ClinicianGroup as HS.SDA3.CodeTableDetail.CareProvider;
If the relationship is between a patient and a clinician group, this is
that group. The Code and Description will be populated by the ID and Name
of the HS.Push.PatientClinicianRelationship:ClinicianGroup, respectively.
The SDACodingStandard will be set to "HSClinicianGroup". This property will
only be populated for group relationships.

Viewer cache:
If present, Clinician will populate CPCareProvDR, else ClinicianGroup will
be used.

SDATableName=CareProvider, ViewerClass=User.HS.CTCareProv
VIEWERLIB: User.HS.PAPersonCareProvider(CPCareProvDR)

.CareProviderType
The Code and Description come from the Name and Description of the
HS.Push.PatientClinicianRelationship:Relationship. The SDACodingStandard is
set to "HSRelationshipType".
Property methods: ClinicianGroupGet(), ClinicianGroupGetObject(), ClinicianGroupGetObjectId(), ClinicianGroupGetSwizzled(), ClinicianGroupIsEmpty(), ClinicianGroupIsValid(), ClinicianGroupNewObject(), ClinicianGroupSet(), ClinicianGroupSetObject(), ClinicianGroupSetObjectId(), ClinicianGroupUnSwizzle()
property EncounterNumber as %String (MAXLEN = 220);
Used for Encounter entities VIEWERLIB: Not stored
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
property ExpirationDate as HS.SDA3.TimeStamp;
Populated by the ExpirationDate of the
HS.Push.PatientClinicianRelationship.

VIEWERLIB: Not stored
Property methods: ExpirationDateDisplayToLogical(), ExpirationDateGet(), ExpirationDateIsValid(), ExpirationDateLogicalToDisplay(), ExpirationDateLogicalToTimeStamp(), ExpirationDateLogicalToXSD(), ExpirationDateNormalize(), ExpirationDateOdbcToLogical(), ExpirationDateSet(), ExpirationDateXSDToLogical()
property FacilityCode as %String;
For individual clinician relationships, this is the facility code for the
clinician's primary facility.

Viewer cache:
FacilityCode is stored in a code table in the Viewer Cache
(User.HS.CTResponsibleUnit), but because it is not a CodeTableDetail, it is
not subjected to CodeTableDetail matching. Instead, matching is simply done
on RUCode, ALPHAUP collated. If no matching CTResponsibleUnit is found, a
new one is created with RUCode and RUDesc = FacilityCode.

VIEWERLIB: User.HS.PAPersonCareProvider(CPRespUnitDR)
Property methods: FacilityCodeDisplayToLogical(), FacilityCodeGet(), FacilityCodeIsValid(), FacilityCodeLogicalToDisplay(), FacilityCodeLogicalToOdbc(), FacilityCodeNormalize(), FacilityCodeSet()
property StartDate as HS.SDA3.TimeStamp;
Populated by the StartDate of the
HS.Push.PatientClinicianRelationship.

VIEWERLIB: Not stored
Property methods: StartDateDisplayToLogical(), StartDateGet(), StartDateIsValid(), StartDateLogicalToDisplay(), StartDateLogicalToTimeStamp(), StartDateLogicalToXSD(), StartDateNormalize(), StartDateOdbcToLogical(), StartDateSet(), StartDateXSDToLogical()
property Status as HS.SDA3.CodeTableDetail.ClinicalRelationshipStatus;
Indicates the current state of the care team. This field is not present in nor populated from the Registry. It is used for the FHIR CareTeam resource and values are derived for clinician-patient relationships from the Registry. See the FHIR Annotations for more details. VIEWERLIB: Not stored
Property methods: StatusGet(), StatusGetObject(), StatusGetObjectId(), StatusGetSwizzled(), StatusIsEmpty(), StatusIsValid(), StatusNewObject(), StatusSet(), StatusSetObject(), StatusSetObjectId(), StatusUnSwizzle()

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

Inherited Methods

FeedbackOpens in a new tab