Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
ActivityTiming
AllergyIntolerance
AuthorNote
CareObservation
CarePerformer
CareRegisteredDevice
DiagnosticSummary
ClinicalAlert
ClinicalDetectedIssue
ClinicalDetectedIssueDetail
ClinicalEncounter
ClinicalServiceRequest
CodeSet
CodeSetBundle
ContactProfile
HealthcareFacility
HealthCondition
HealthRiskEvaluation
HealthRiskEvalDetail
HealthRiskEvalOutcome
Identifier
Medication
MedicationAdministration
MedicationDispense
MedicationRequest
MedicationStatement
PatientHealthReaction
PatientImmunization
PatientMedicalProcedure
PatientMedicationDosage
PersonLanguage
PersonName
ProblemDefRelationship
Specimen
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

CareRegisteredDevice

Represents a device or device registration information for a patient or a care program enrollee. This object is available in API version 49.0 and later.

Supported Calls

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

Fields

Field Details
CareProgramEnrolleeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the care program enrollee to whom this device is registered.
DeviceId
Type
Master-detail reference
Properties
Create, Filter, Group, Sort
Description
The asset ID for the device.
Referenced Objects
Asset
DeviceTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents the type of the device.
Examples: Cystoscope, oxygen tent
Referenced Objects
CodeSet
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of this device registration record.
PatientId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account ID of the patient to whom this device is registered.
Referenced Objects
Account
RegistrationDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when this device was registered.
SafetyInformation
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The health and safety information about with the device.
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system from which the record was sourced.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the system from which the record was sourced.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates whether the device registration is active.
Possible values are:
  • Active
  • Inactive
SupportContactDetail
Type
textarea
Properties
Create, Nillable, Update
Description
Contact details of the person or organization that provides support for the device.
UniqueDeviceId1
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions.
UniqueDeviceId1Issuer
Type
url
Properties
Create, Filter, Nillable, Sort, Update
Description
The organization that issued the UDI1 for the device.
UniqueDeviceId2
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions.
UniqueDeviceId2Issuer
Type
url
Properties
Create, Filter, Nillable, Sort, Update
Description
The organization that issued the UDI2 for the device.
UniqueDeviceId3
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions.
UniqueDeviceId3Issuer
Type
url
Properties
Create, Filter, Nillable, Sort, Update
Description
The organization that issued the UDI3 for the device.

Additional Information for CareRegisteredDevice in Other Objects

In addition to creating a record using these fields, you can add more details to your CareRegisteredDevice record by creating records in certain other objects, and referencing your CareRegisteredDevice record as the parent record. Here’s the list of objects you can associate to CareRegisteredDevice in this way, the type of information they add, and the field they use to reference CareRegisteredDevice.

Object Type of Information Reference Field
Identifier Associates an identifier value to the CareRegisteredDevice record. This identifier is not the same as the device’s UID. ParentRecordId

Associated Objects

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

CareRegisteredDeviceChangeEvent (API version 60.0)
Change events are available for the object.
CareRegisteredDeviceFeed
Feed tracking is available for the object.
CareRegisteredDeviceHistory
History is available for tracked fields of the object.