Skip to main content

HS.SDA3.CodeTableDetail.CareProvider

serial class HS.SDA3.CodeTableDetail.CareProvider extends HS.SDA3.CodeTableDetail

In the Viewer Cache, CareProviders are matched on Code, SDACodingStandard,
Description, and CareProviderType (which is itself a code table). Other
properties are updated if different.

Property Inventory

Properties

property Address as HS.SDA3.Address;
Viewer cache:
If the inbound CareProvider has an Address defined, then if the inbound
Street, City, and Zip are not all null and if any differ from the
corresponding properties of the matched CTCareProv, then the CTCareProv
is determined to need an update (of all properties, not just Address).
On add or update, the properties of Address listed below will only be
inserted into the Viewer Cache if at least one of the properties is not
null. If so, then the properties will all be inserted into the Viewer
Cache, even nulls, and even if they overwrite non-null values.
Note that CTPCPStName is of type List of %String. HealthShare will only
ever populate the first entry in the list.

.Street
VIEWERLIB: User.HS.CTCareProv(CTPCPStName)
.City
VIEWERLIB: User.HS.CTCareProv(CTPCPCityDR)
.Zip
VIEWERLIB: User.HS.CTCareProv(CTPCPZipDR)
Property methods: AddressGet(), AddressGetObject(), AddressGetObjectId(), AddressGetSwizzled(), AddressIsEmpty(), AddressIsValid(), AddressNewObject(), AddressSet(), AddressSetObject(), AddressSetObjectId(), AddressUnSwizzle()
property AtOrganization as HS.SDA3.CodeTableDetail.OrganizationA;
This is to support use cases such as "individual provider at organization", which is needed for care community. VIEWERLIB: Not stored
Property methods: AtOrganizationGet(), AtOrganizationGetObject(), AtOrganizationGetObjectId(), AtOrganizationGetSwizzled(), AtOrganizationIsEmpty(), AtOrganizationIsValid(), AtOrganizationNewObject(), AtOrganizationSet(), AtOrganizationSetObject(), AtOrganizationSetObjectId(), AtOrganizationUnSwizzle()
property CareProviderType as HS.SDA3.CodeTableDetail.CareProviderType;
This field may either refer to the specialty of the clinician
(cardiologist, radiologist, etc.) or to his role in a given scenario
(admitting, attending, etc.).

Viewer cache:
CareProviderType is a match property for CareProvider in the Viewer Cache.
That is, it must match the existing CTPCPCarPrvTpDR for the CareProviders
to be considered a match. A null value (either inbound or existing) will
not match a non-null value.

SDATableName=CareProviderType, ViewerClass=User.HS.CTCarPrvTp
VIEWERLIB: User.HS.CTCareProv(CTPCPCarPrvTpDR)
Property methods: CareProviderTypeGet(), CareProviderTypeGetObject(), CareProviderTypeGetObjectId(), CareProviderTypeGetSwizzled(), CareProviderTypeIsEmpty(), CareProviderTypeIsValid(), CareProviderTypeNewObject(), CareProviderTypeSet(), CareProviderTypeSetObject(), CareProviderTypeSetObjectId(), CareProviderTypeUnSwizzle()
property Code as HS.SDA3.StrippedString (MAXLEN = 32000);
The primary identifier for the provider.
Use the OtherIdentifiers property to list additional identifiers.

VIEWERLIB: User.HS.CTCareProv(CTPCPCode)
Property methods: CodeDisplayToLogical(), CodeGet(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeSet(), CodeSystemVersionIdDisplayToLogical(), CodeSystemVersionIdGet(), CodeSystemVersionIdIsValid(), CodeSystemVersionIdLogicalToDisplay(), CodeSystemVersionIdLogicalToOdbc(), CodeSystemVersionIdNormalize(), CodeSystemVersionIdSet(), CodeXSDToLogical()
property ContactInfo as HS.SDA3.ContactInfo;
Viewer cache:
For each of the properties of ContactInfo, if the inbound property is
non-null and does not match the corresponding property of the matched
CTCareProv, then the CTCareProv is determined to need an update (of all
properties, not just ContactInfo).
On add or update, for each of the properties of ContactInfo, the inbound
property will only be inserted into the Viewer Cache if it is non-null.

.HomePhoneNumber
VIEWERLIB: User.HS.CTCareProv(CTPCPTelH)
.WorkPhoneNumber
VIEWERLIB: User.HS.CTCareProv(CTPCPTelO)
.MobilePhoneNumber
VIEWERLIB: User.HS.CTCareProv(CTPCPMobilePhone)
.EmailAddress
VIEWERLIB: User.HS.CTCareProv(CTPCPEmail)
Property methods: ContactInfoGet(), ContactInfoGetObject(), ContactInfoGetObjectId(), ContactInfoGetSwizzled(), ContactInfoIsEmpty(), ContactInfoIsValid(), ContactInfoNewObject(), ContactInfoSet(), ContactInfoSetObject(), ContactInfoSetObjectId(), ContactInfoUnSwizzle()
property Description as HS.SDA3.StrippedString (MAXLEN = 32000);
VIEWERLIB: User.HS.CTCareProv(CTPCPDesc)
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet(), DescriptionXSDToLogical()
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property IdentifierTypeCode as %String (MAXLEN = 50);
Indicates the type of identifier populated in the Code property.
For example: "NPI" for "National provider identifier". See HL7 table 203.

VIEWERLIB: Not stored
Property methods: IdentifierTypeCodeDisplayToLogical(), IdentifierTypeCodeGet(), IdentifierTypeCodeIsValid(), IdentifierTypeCodeLogicalToDisplay(), IdentifierTypeCodeLogicalToOdbc(), IdentifierTypeCodeNormalize(), IdentifierTypeCodeSet(), IdentifierTypeCodeSystemDisplayToLogical(), IdentifierTypeCodeSystemGet(), IdentifierTypeCodeSystemIsValid(), IdentifierTypeCodeSystemLogicalToDisplay(), IdentifierTypeCodeSystemLogicalToOdbc(), IdentifierTypeCodeSystemNormalize(), IdentifierTypeCodeSystemSet()
property IdentifierTypeCodeSystem as %String);
Indicates the code system for the IdentifierTypeCode value.
VIEWERLIB: Not stored
Property methods: IdentifierTypeCodeSystemDisplayToLogical(), IdentifierTypeCodeSystemGet(), IdentifierTypeCodeSystemIsValid(), IdentifierTypeCodeSystemLogicalToDisplay(), IdentifierTypeCodeSystemLogicalToOdbc(), IdentifierTypeCodeSystemNormalize(), IdentifierTypeCodeSystemSet()
property Name as HS.SDA3.Name;
Viewer cache:
If the inbound CareProvider has a Name defined, then if the inbound
FamilyName, GivenName, MiddleName, NamePrefix, FamilyNamePrefix,
NameSuffix, and ProfessionalSuffix are not all null and if any differ from
the corresponding properties of the matched CTCareProv, then the CTCareProv
is determined to need an update (of all properties, not just Name).
On add or update, the properties of Name listed below will only be inserted
into the Viewer Cache if at least one of the properties is not null. If so,
then the properties will all be inserted into the Viewer Cache, even nulls,
and even if they overwrite non-null values.

.FamilyName
VIEWERLIB: User.HS.CTCareProv(CTPCPSurname)
.GivenName
VIEWERLIB: User.HS.CTCareProv(CTPCPFirstName)
.MiddleName
VIEWERLIB: User.HS.CTCareProv(CTPCPOtherName)
.NamePrefix
VIEWERLIB: User.HS.CTCareProv(CTPCPTitle)
.FamilyNamePrefix
VIEWERLIB: User.HS.CTCareProv(CTPCPTextOne)
.NameSuffix
VIEWERLIB: User.HS.CTCareProv(CTPCPTextTwo)
.ProfessionalSuffix
VIEWERLIB: User.HS.CTCareProv(CTPCPTextThree)
Property methods: NameGet(), NameGetObject(), NameGetObjectId(), NameGetSwizzled(), NameIsEmpty(), NameIsValid(), NameNewObject(), NameSet(), NameSetObject(), NameSetObjectId(), NameTypeCodeDisplayToLogical(), NameTypeCodeGet(), NameTypeCodeIsValid(), NameTypeCodeLogicalToDisplay(), NameTypeCodeLogicalToOdbc(), NameTypeCodeNormalize(), NameTypeCodeSet(), NameUnSwizzle()
property NameTypeCode as %String;
A code that represents the type of name. For example: "L"\"Legal",
"M"\"Maiden", "A"\"Alias". See HL7 table 200.

VIEWERLIB: Not stored
Property methods: NameTypeCodeDisplayToLogical(), NameTypeCodeGet(), NameTypeCodeIsValid(), NameTypeCodeLogicalToDisplay(), NameTypeCodeLogicalToOdbc(), NameTypeCodeNormalize(), NameTypeCodeSet()
property OtherIdentifiers as list of HS.SDA3.Identifier;
Provides support for additional identifiers associated with a provider.
Property methods: OtherIdentifiersBuildValueArray(), OtherIdentifiersCollectionToDisplay(), OtherIdentifiersCollectionToOdbc(), OtherIdentifiersDisplayToCollection(), OtherIdentifiersGet(), OtherIdentifiersGetObject(), OtherIdentifiersGetObjectId(), OtherIdentifiersGetSwizzled(), OtherIdentifiersIsValid(), OtherIdentifiersOdbcToCollection(), OtherIdentifiersSet(), OtherIdentifiersSetObject(), OtherIdentifiersSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab