ClinicalEncounterIdentifier

Represents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

Field	Details
ClinicalEncounterId	Type Master-detail reference Properties Create, Filter, Group, Sort Description The parent clinical encounter that this identifier belongs to. Referenced Objects ClinicalEncounter
EffectiveDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time from when the identifier is in effect.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time from when the identifier is no longer in effect.
IdTypeId	Type Polymorphic reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the type of the identifier. Referenced Objects CodeSet CodeSetBundle
IdUsageType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of use of the identifier. Possible values are: `Official` `Old` `Secondary` `Temp` `Usual`
IdValue	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The unique value of the identifier. No two ClinicalEncounterIdentifier records in an org can share the same IdValue.
IssuingAuthorityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The authority or organization 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 of the ClinicalEncounterIdentifier record.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source system that the identifier belongs to.

Usage

Once the identifier-related information is recorded in the ClinicalEncounterIdentifier record, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field.

Associated Objects

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

ClinicalEncounterIdentifierFeed: Feed tracking is available for the object.
ClinicalEncounterIdentifierHistory: History is available for tracked fields of the object.
ClinicalEncounterIdentifierChangeEvent (API version 61.0): Change events are available for the object.

Salesforce Health Cloud Developer Guide

ClinicalEncounterIdentifier

Supported Calls

Fields

Usage

Associated Objects