Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

CareSystemFieldMapping

Represents a mapping from source system fields to Salesforce target entities and attributes.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field Name	Details
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API.
ExternalIdField	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the field in the external system.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the record is active.
NamespacePrefix	Type string Properties Filter, Nillable Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
MasterLabel	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The label for this care system field mapping.
Role	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The role that the entity represents. Picklist values `RemoteMonitoringDevice` and `RemoteMonitoringPatient` are available from API version 49.0 and later. Possible values are: `Patient`—When the role field is set to `Patient`, the Enrollment API uses the value of externalIdField as the patient ID. This role can be used when targetObject is set to `Account`. `RemoteMonitoringDevice`—Indicates which externalIdField on the Asset object maps to the Device field in the CareObservation object. This role can be used when targetObject is set to Asset. `RemoteMonitoringPatient`—Indicates which externalIdField on the Account object maps to the ObservedSubject field in the Care Observation object. This role is used when targetObject is set to Account. `ServiceProvider`—The Enrollment API uses the value of externalIdField as the provider ID. This role is used when targetObject is set to `Account`. `NotApplicable`—This role is used when targetObject is set to `CareProgram` or `Product`, which means that there is no applicable role.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description System from which the record was sourced.
TargetObject	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the parent entity for the external ID.