Identifier | Salesforce Health Cloud Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Fields

Field	Details
EffectiveDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time from when the identifier is valid.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time from when the identifier is no longer valid.
IdTypeId	Type Polymorphic reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the type of ID the identifier is. Referenced Objects CodeSet CodeSetBundle
IdUsageType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of use of the ID. Possible values are: `Official` `Old` `Secondary` `Temp` `Usual`
IdValue	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of the identifier.
IdentifierKey	Type string Properties Filter, Group, idLookup, Nillable, Sort Description A unique key assigned to the identifier record. This is a calculated field.
IssuingAuthorityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The authorized body that issued the identifier. Referenced Objects Account
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last referenced.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last viewed.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated name for the identifier record.
ParentRecordId	Type Polymorphic master-detail reference Properties Create, Filter, Group, Sort Description The parent entity associated with the identifier. Referenced Objects Account BoardCertification Contact CareRegisteredDevice Medication HealthCondition AllergyIntolerance PatientMedicalProcedure PatientImmunization MedicationStatement ClinicalEncounter HealthcareFacility HealthcareProvider ClinicalAlert MedicationRequest DiagnosticSummary HealthcarePractitionerFacility ClinicalServiceRequest ClinicalDetectedIssue—This value is available in API version 55.0 and later.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source system from which the identifier record was brought into Salesforce.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the identifier record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the identifier record was last modified in its source system.

Usage

The identifier object is used to assign identifiers to records in various other objects. Here’s a list of the objects whose records you can add identifiers to:

Account
Contact
Board Certification
Medication
HealthCondition
AllergyIntolerance
PatientMedicalProcedure
PatientImmunization
MedicationStatement
ClinicalEncounter
HealthcareFacility
ClinicalAlert
MedicationRequest
DiagnosticSummary
HealthcarePractitionerFacility
ClinicalServiceRequest
ClinicalDetectedIssue

You connect the identifier record to its related record in any of the listed objects by referencing that record using the ParentRecordId field.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

IdentifierChangeEvent (API version 61.0): Change events are available for the object.