BusinessLicense

Represents the licenses of a party role like healthcare provider or producer. Available in API version 46.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the organization holding the license.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the person who holds the license and is listed as a contact.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Description of the license.
HealthcareProviderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the Healthcare Provider who holds this license. This field is a lookup to HealthcareProvider.
Identifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Issuer's ID for the licensee. This field is unique within your organization.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the license is active. The default value is false.
isPrimaryLicense
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the license is the primary license. The default value is false.
IssueDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the license or certification was issued.
Issuer
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
License issuer's name.
JurisdictionCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country where license is valid.
JurisdictionOther
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of other jurisdiction.
JurisdictionState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State where license is valid.
JurisdictionType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Jurisdiction for the license. Possible values:
  • STATE
  • COUNTRY
  • PROVINCE
  • COUNTY
LicenseClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The class that the distributor’s license belongs to. This field is available from API version 48.0 and later.
Possible values are:
  • APN - Advanced Practice Nurse
  • LPN - Licensed Practical Nurse
  • MD - Medical Doctor (MD)
  • PC - Professional Counselor
  • PT - Physical Therapist
LicenseNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of the license.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the business or professional license.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
PeriodEnd
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
License's expiration date.
PeriodStart
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
License's effective start date.
SourceSystemUpdateDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Current status of the license. Example values:
  • Inactive
  • Revoked
  • Draft
  • Verified
UserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Person who holds the license and is listed as a user.
VerificationStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Current status for the license. Possible values:
  • Authorized
VerifiedDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
License was validated on this date.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

BusinessLicenseFeed
Feed tracking is available for the object.
BusinessLicenseHistory
History is available for tracked fields of the object.
BusinessLicenseOwnerSharingRule
Sharing rules are available for the object.
BusinessLicenseShare
Sharing is available for the object.