BusinessLicense

Represents the licenses of a party role like healthcare provider or producer.

Special Access Rules

In Health Cloud, this object is available in API version 46.0 and later.

Supported Calls

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

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the organization holding the license. This field is a relationship field.
Relationship Name: Account
Refers To: Account

ContactId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the person who holds the license and is listed as a contact. This field is a relationship field.
Relationship Name: Contact
Refers To: 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 relationship field. This field is a lookup to HealthcareProvider.
Relationship Name: HealthcareProvider
Refers 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 (true) or not (false).
Default value: false

IsPrimaryLicense

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the license is the primary license.
Default value: 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.
Default value: STATE
Possible values:
- COUNTRY
- COUNTY
- PROVINCE
- STATE

LicenseClass

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The class that the distributor’s license belongs to.

In Health Cloud, this field is available from API version 48.0 and later.

Possible values:
- 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. This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

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
Description: Represents the date when the record was last updated in the source system.

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Current status of the license.
Default value: Inactive
Possible values:
- Draft
- Inactive
- Revoked
- Verified

UserId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The person who holds the license and is listed as a user. This field is a relationship field.
Relationship Name: User
Refers To: User

VerificationStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Current status for the license.
Default value: Authorized
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.